WORKERS AHEAD!

You are viewing the development documentation for the Apereo CAS server. The functionality presented here is not officially released yet. This is a work in progress and will be continually updated as development moves forward. You are most encouraged to test the changes presented.

Overview

CAS takes advantages of Swagger to produce API documentation automatically. The generated documentation supports all CAS endpoints and REST APIs provided they are made available to the runtime application context and are present in the overlay.

Support is enabled by including the following dependency in the overlay:

<dependency>
    <groupId>org.apereo.cas</groupId>
    <artifactId>cas-server-support-swagger</artifactId>
    <version>${cas.version}</version>
</dependency>

implementation "org.apereo.cas:cas-server-support-swagger:${project.'cas.version'}"

dependencyManagement {
    imports {
        mavenBom "org.apereo.cas:cas-server-support-bom:${project.'cas.version'}"
    }
}

dependencies {
    implementation "org.apereo.cas:cas-server-support-swagger"
}

dependencies {
    /*
        The following platform references should be included automatically and are listed here for reference only.

        implementation enforcedPlatform("org.apereo.cas:cas-server-support-bom:${project.'cas.version'}")
        implementation platform(org.springframework.boot.gradle.plugin.SpringBootPlugin.BOM_COORDINATES)
        
    */
    implementation "org.apereo.cas:cas-server-support-swagger"
}

The following settings and properties are available from the CAS configuration catalog:

_{The configuration settings listed below are tagged as Required in the CAS configuration metadata. This flag indicates that the presence of the setting may be needed to activate or affect the behavior of the CAS feature and generally should be reviewed, possibly owned and adjusted. If the setting is assigned a default value, you do not need to strictly put the setting in your copy of the configuration, but should review it nonetheless to make sure it matches your deployment expectations.}

_{The configuration settings listed below are tagged as Optional in the CAS configuration metadata. This
flag indicates that the presence of the setting
is not immediately necessary in the end-user CAS configuration, because a default value is assigned or
the activation of the feature is not conditionally controlled by the setting value. In other words, you should only include this field in your
configuration if you need to modify the default value or if you need to turn on the feature controlled by the setting.}

_{The configuration settings listed below are tagged as Third Party in the CAS configuration metadata. This flag indicates that the configuration setting is not controlled, owned or managed by the CAS ecosystem, and affects functionality that is offered by a third-party library, such as Spring Boot or Spring Cloud to CAS. For additional info, you might have to visit the third-party source to find more details.}

springdoc.api-docs.enabled=true

Whether to generate and serve an OpenAPI document.

org.springdoc.core.properties.SpringDocConfigProperties$ApiDocs.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value. The only possible exception to this rule is when naming actuator endpoints; The name of the actuator endpoints (i.e. ssoSessions) MUST remain in camelCase mode.

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

springdoc.api-docs.enabled=true

This is the most common form of property configuration that is recognized by CAS, regardless of the actual property source, which might in fact be managed separately outside the CAS environment, by another system or cloud framework.

CAS properties can be specified using the YAML syntax:

springdoc: 
  api-docs: 
    enabled: "true"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspringdoc.api-docs.enabled="true" -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory. Note the placement of the system property which must be specified before the CAS web application is launched.

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRINGDOC_API_DOCS_ENABLED="true"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --springdoc.api-docs.enabled="true"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

springdoc.api-docs.groups.enabled=false

The Enabled.

org.springdoc.core.properties.SpringDocConfigProperties$Groups.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

springdoc.api-docs.groups.enabled=...

CAS properties can be specified using the YAML syntax:

springdoc: 
  api-docs: 
    groups: 
      enabled: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspringdoc.api-docs.groups.enabled="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRINGDOC_API_DOCS_GROUPS_ENABLED="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --springdoc.api-docs.groups.enabled="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

springdoc.api-docs.path=

Path to the generated OpenAPI documentation. For a yaml file, append ".yaml" to the path.

org.springdoc.core.properties.SpringDocConfigProperties$ApiDocs.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

springdoc.api-docs.path=...

CAS properties can be specified using the YAML syntax:

springdoc: 
  api-docs: 
    path: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspringdoc.api-docs.path="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRINGDOC_API_DOCS_PATH="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --springdoc.api-docs.path="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

springdoc.api-docs.resolve-extensions-properties=false

The Resolve extensions properties.

org.springdoc.core.properties.SpringDocConfigProperties$ApiDocs.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

springdoc.api-docs.resolve-extensions-properties=...

CAS properties can be specified using the YAML syntax:

springdoc: 
  api-docs: 
    resolve-extensions-properties: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspringdoc.api-docs.resolve-extensions-properties="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRINGDOC_API_DOCS_RESOLVE_EXTENSIONS_PROPERTIES="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --springdoc.api-docs.resolve-extensions-properties="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

springdoc.api-docs.resolve-schema-properties=false

The Resolve schema properties.

org.springdoc.core.properties.SpringDocConfigProperties$ApiDocs.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

springdoc.api-docs.resolve-schema-properties=...

CAS properties can be specified using the YAML syntax:

springdoc: 
  api-docs: 
    resolve-schema-properties: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspringdoc.api-docs.resolve-schema-properties="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRINGDOC_API_DOCS_RESOLVE_SCHEMA_PROPERTIES="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --springdoc.api-docs.resolve-schema-properties="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

springdoc.api-docs.version=

The OpenAPI version.

org.springdoc.core.properties.SpringDocConfigProperties$ApiDocs.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

springdoc.api-docs.version=...

CAS properties can be specified using the YAML syntax:

springdoc: 
  api-docs: 
    version: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspringdoc.api-docs.version="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRINGDOC_API_DOCS_VERSION="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --springdoc.api-docs.version="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

springdoc.auto-tag-classes=true

The Auto tag classes.

org.springdoc.core.properties.SpringDocConfigProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

springdoc.auto-tag-classes=true

CAS properties can be specified using the YAML syntax:

springdoc: 
  auto-tag-classes: "true"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspringdoc.auto-tag-classes="true" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRINGDOC_AUTO_TAG_CLASSES="true"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --springdoc.auto-tag-classes="true"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

springdoc.cache.disabled=false

The Disabled.

org.springdoc.core.properties.SpringDocConfigProperties$Cache.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

springdoc.cache.disabled=...

CAS properties can be specified using the YAML syntax:

springdoc: 
  cache: 
    disabled: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspringdoc.cache.disabled="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRINGDOC_CACHE_DISABLED="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --springdoc.cache.disabled="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

springdoc.consumes-to-match=

The Consumes to match.

org.springdoc.core.properties.SpringDocConfigProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

springdoc.consumes-to-match=...

CAS properties can be specified using the YAML syntax:

springdoc: 
  consumes-to-match: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspringdoc.consumes-to-match="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRINGDOC_CONSUMES_TO_MATCH="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --springdoc.consumes-to-match="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

springdoc.default-consumes-media-type=

The Default consumes media type.

org.springdoc.core.properties.SpringDocConfigProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

springdoc.default-consumes-media-type=...

CAS properties can be specified using the YAML syntax:

springdoc: 
  default-consumes-media-type: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspringdoc.default-consumes-media-type="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRINGDOC_DEFAULT_CONSUMES_MEDIA_TYPE="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --springdoc.default-consumes-media-type="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

springdoc.default-flat-param-object=false

The param default flatten

org.springdoc.core.properties.SpringDocConfigProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

springdoc.default-flat-param-object=...

CAS properties can be specified using the YAML syntax:

springdoc: 
  default-flat-param-object: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspringdoc.default-flat-param-object="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRINGDOC_DEFAULT_FLAT_PARAM_OBJECT="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --springdoc.default-flat-param-object="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

springdoc.default-produces-media-type=

The Default produces media type.

org.springdoc.core.properties.SpringDocConfigProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

springdoc.default-produces-media-type=...

CAS properties can be specified using the YAML syntax:

springdoc: 
  default-produces-media-type: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspringdoc.default-produces-media-type="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRINGDOC_DEFAULT_PRODUCES_MEDIA_TYPE="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --springdoc.default-produces-media-type="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

springdoc.default-support-form-data=false

convert query param to form data when consumes is multipart/form-data

org.springdoc.core.properties.SpringDocConfigProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

springdoc.default-support-form-data=...

CAS properties can be specified using the YAML syntax:

springdoc: 
  default-support-form-data: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspringdoc.default-support-form-data="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRINGDOC_DEFAULT_SUPPORT_FORM_DATA="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --springdoc.default-support-form-data="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

springdoc.disable-i18n=false

The Disable i18n.

org.springdoc.core.properties.SpringDocConfigProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

springdoc.disable-i18n=...

CAS properties can be specified using the YAML syntax:

springdoc: 
  disable-i18n: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspringdoc.disable-i18n="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRINGDOC_DISABLE_I18N="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --springdoc.disable-i18n="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

springdoc.enable-data-rest=true

The Enable hateoas.

org.springdoc.core.properties.SpringDocConfigProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

springdoc.enable-data-rest=true

CAS properties can be specified using the YAML syntax:

springdoc: 
  enable-data-rest: "true"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspringdoc.enable-data-rest="true" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRINGDOC_ENABLE_DATA_REST="true"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --springdoc.enable-data-rest="true"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

springdoc.enable-default-api-docs=true

The Enable default api docs.

org.springdoc.core.properties.SpringDocConfigProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

springdoc.enable-default-api-docs=true

CAS properties can be specified using the YAML syntax:

springdoc: 
  enable-default-api-docs: "true"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspringdoc.enable-default-api-docs="true" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRINGDOC_ENABLE_DEFAULT_API_DOCS="true"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --springdoc.enable-default-api-docs="true"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

springdoc.enable-groovy=true

The Enable groovy.

org.springdoc.core.properties.SpringDocConfigProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

springdoc.enable-groovy=true

CAS properties can be specified using the YAML syntax:

springdoc: 
  enable-groovy: "true"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspringdoc.enable-groovy="true" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRINGDOC_ENABLE_GROOVY="true"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --springdoc.enable-groovy="true"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

springdoc.enable-hateoas=true

The Enable hateoas.

org.springdoc.core.properties.SpringDocConfigProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

springdoc.enable-hateoas=true

CAS properties can be specified using the YAML syntax:

springdoc: 
  enable-hateoas: "true"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspringdoc.enable-hateoas="true" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRINGDOC_ENABLE_HATEOAS="true"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --springdoc.enable-hateoas="true"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

springdoc.enable-javadoc=true

The Enable javadoc.

org.springdoc.core.properties.SpringDocConfigProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

springdoc.enable-javadoc=true

CAS properties can be specified using the YAML syntax:

springdoc: 
  enable-javadoc: "true"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspringdoc.enable-javadoc="true" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRINGDOC_ENABLE_JAVADOC="true"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --springdoc.enable-javadoc="true"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

springdoc.enable-kotlin=true

The Enable kotlin.

org.springdoc.core.properties.SpringDocConfigProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

springdoc.enable-kotlin=true

CAS properties can be specified using the YAML syntax:

springdoc: 
  enable-kotlin: "true"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspringdoc.enable-kotlin="true" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRINGDOC_ENABLE_KOTLIN="true"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --springdoc.enable-kotlin="true"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

springdoc.enable-spring-security=true

The Enable spring security.

org.springdoc.core.properties.SpringDocConfigProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

springdoc.enable-spring-security=true

CAS properties can be specified using the YAML syntax:

springdoc: 
  enable-spring-security: "true"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspringdoc.enable-spring-security="true" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRINGDOC_ENABLE_SPRING_SECURITY="true"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --springdoc.enable-spring-security="true"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

springdoc.group-configs=

The Group configs.

org.springdoc.core.properties.SpringDocConfigProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

springdoc.group-configs=...

CAS properties can be specified using the YAML syntax:

springdoc: 
  group-configs: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspringdoc.group-configs="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRINGDOC_GROUP_CONFIGS="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --springdoc.group-configs="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

springdoc.headers-to-match=

The Headers to match.

org.springdoc.core.properties.SpringDocConfigProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

springdoc.headers-to-match=...

CAS properties can be specified using the YAML syntax:

springdoc: 
  headers-to-match: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspringdoc.headers-to-match="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRINGDOC_HEADERS_TO_MATCH="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --springdoc.headers-to-match="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

springdoc.model-and-view-allowed=false

The Model and view allowed.

org.springdoc.core.properties.SpringDocConfigProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

springdoc.model-and-view-allowed=...

CAS properties can be specified using the YAML syntax:

springdoc: 
  model-and-view-allowed: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspringdoc.model-and-view-allowed="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRINGDOC_MODEL_AND_VIEW_ALLOWED="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --springdoc.model-and-view-allowed="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

springdoc.model-converters.deprecating-converter.enabled=false

The Enabled.

org.springdoc.core.properties.SpringDocConfigProperties$ModelConverters$DeprecatingConverter.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

springdoc.model-converters.deprecating-converter.enabled=...

CAS properties can be specified using the YAML syntax:

springdoc: 
  model-converters: 
    deprecating-converter: 
      enabled: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspringdoc.model-converters.deprecating-converter.enabled="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRINGDOC_MODEL_CONVERTERS_DEPRECATING_CONVERTER_ENABLED="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --springdoc.model-converters.deprecating-converter.enabled="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

springdoc.model-converters.pageable-converter.enabled=false

The Enabled.

org.springdoc.core.properties.SpringDocConfigProperties$ModelConverters$PageableConverter.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

springdoc.model-converters.pageable-converter.enabled=...

CAS properties can be specified using the YAML syntax:

springdoc: 
  model-converters: 
    pageable-converter: 
      enabled: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspringdoc.model-converters.pageable-converter.enabled="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRINGDOC_MODEL_CONVERTERS_PAGEABLE_CONVERTER_ENABLED="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --springdoc.model-converters.pageable-converter.enabled="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

springdoc.model-converters.polymorphic-converter.enabled=false

The Enabled.

org.springdoc.core.properties.SpringDocConfigProperties$ModelConverters$PolymorphicConverter.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

springdoc.model-converters.polymorphic-converter.enabled=...

CAS properties can be specified using the YAML syntax:

springdoc: 
  model-converters: 
    polymorphic-converter: 
      enabled: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspringdoc.model-converters.polymorphic-converter.enabled="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRINGDOC_MODEL_CONVERTERS_POLYMORPHIC_CONVERTER_ENABLED="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --springdoc.model-converters.polymorphic-converter.enabled="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

springdoc.nullable-request-parameter-enabled=false

The Nullable request parameter enabled.

org.springdoc.core.properties.SpringDocConfigProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

springdoc.nullable-request-parameter-enabled=...

CAS properties can be specified using the YAML syntax:

springdoc: 
  nullable-request-parameter-enabled: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspringdoc.nullable-request-parameter-enabled="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRINGDOC_NULLABLE_REQUEST_PARAMETER_ENABLED="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --springdoc.nullable-request-parameter-enabled="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

springdoc.open-api=

org.springdoc.core.properties.SpringDocConfigProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

springdoc.open-api=...

CAS properties can be specified using the YAML syntax:

springdoc: 
  open-api: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspringdoc.open-api="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRINGDOC_OPEN_API="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --springdoc.open-api="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

springdoc.override-with-generic-response=

The Override with generic response.

org.springdoc.core.properties.SpringDocConfigProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

springdoc.override-with-generic-response=...

CAS properties can be specified using the YAML syntax:

springdoc: 
  override-with-generic-response: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspringdoc.override-with-generic-response="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRINGDOC_OVERRIDE_WITH_GENERIC_RESPONSE="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --springdoc.override-with-generic-response="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

springdoc.packages-to-exclude=

The Packages to exclude.

org.springdoc.core.properties.SpringDocConfigProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

springdoc.packages-to-exclude=...

CAS properties can be specified using the YAML syntax:

springdoc: 
  packages-to-exclude: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspringdoc.packages-to-exclude="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRINGDOC_PACKAGES_TO_EXCLUDE="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --springdoc.packages-to-exclude="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

springdoc.packages-to-scan=

The Packages to scan.

org.springdoc.core.properties.SpringDocConfigProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

springdoc.packages-to-scan=...

CAS properties can be specified using the YAML syntax:

springdoc: 
  packages-to-scan: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspringdoc.packages-to-scan="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRINGDOC_PACKAGES_TO_SCAN="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --springdoc.packages-to-scan="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

springdoc.paths-to-exclude=

The Paths to exclude.

org.springdoc.core.properties.SpringDocConfigProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

springdoc.paths-to-exclude=...

CAS properties can be specified using the YAML syntax:

springdoc: 
  paths-to-exclude: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspringdoc.paths-to-exclude="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRINGDOC_PATHS_TO_EXCLUDE="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --springdoc.paths-to-exclude="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

springdoc.paths-to-match=

The Paths to match.

org.springdoc.core.properties.SpringDocConfigProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

springdoc.paths-to-match=...

CAS properties can be specified using the YAML syntax:

springdoc: 
  paths-to-match: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspringdoc.paths-to-match="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRINGDOC_PATHS_TO_MATCH="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --springdoc.paths-to-match="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

springdoc.pre-loading-enabled=false

Allow for pre-loading OpenAPI

org.springdoc.core.properties.SpringDocConfigProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

springdoc.pre-loading-enabled=...

CAS properties can be specified using the YAML syntax:

springdoc: 
  pre-loading-enabled: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspringdoc.pre-loading-enabled="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRINGDOC_PRE_LOADING_ENABLED="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --springdoc.pre-loading-enabled="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

springdoc.pre-loading-locales=

locale list to pre-loading

org.springdoc.core.properties.SpringDocConfigProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

springdoc.pre-loading-locales=...

CAS properties can be specified using the YAML syntax:

springdoc: 
  pre-loading-locales: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspringdoc.pre-loading-locales="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRINGDOC_PRE_LOADING_LOCALES="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --springdoc.pre-loading-locales="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

springdoc.produces-to-match=

The Produces to match.

org.springdoc.core.properties.SpringDocConfigProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

springdoc.produces-to-match=...

CAS properties can be specified using the YAML syntax:

springdoc: 
  produces-to-match: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspringdoc.produces-to-match="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRINGDOC_PRODUCES_TO_MATCH="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --springdoc.produces-to-match="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

springdoc.remove-broken-reference-definitions=true

The Remove broken reference definitions.

org.springdoc.core.properties.SpringDocConfigProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

springdoc.remove-broken-reference-definitions=true

CAS properties can be specified using the YAML syntax:

springdoc: 
  remove-broken-reference-definitions: "true"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspringdoc.remove-broken-reference-definitions="true" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRINGDOC_REMOVE_BROKEN_REFERENCE_DEFINITIONS="true"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --springdoc.remove-broken-reference-definitions="true"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

springdoc.show-actuator=false

The Show actuator.

org.springdoc.core.properties.SpringDocConfigProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

springdoc.show-actuator=...

CAS properties can be specified using the YAML syntax:

springdoc: 
  show-actuator: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspringdoc.show-actuator="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRINGDOC_SHOW_ACTUATOR="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --springdoc.show-actuator="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

springdoc.show-login-endpoint=false

The Show login endpoint.

org.springdoc.core.properties.SpringDocConfigProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

springdoc.show-login-endpoint=...

CAS properties can be specified using the YAML syntax:

springdoc: 
  show-login-endpoint: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspringdoc.show-login-endpoint="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRINGDOC_SHOW_LOGIN_ENDPOINT="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --springdoc.show-login-endpoint="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

springdoc.show-oauth2-endpoints=false

The Show oauth 2 endpoint.

org.springdoc.core.properties.SpringDocConfigProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

springdoc.show-oauth2-endpoints=...

CAS properties can be specified using the YAML syntax:

springdoc: 
  show-oauth2-endpoints: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspringdoc.show-oauth2-endpoints="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRINGDOC_SHOW_OAUTH2_ENDPOINTS="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --springdoc.show-oauth2-endpoints="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

springdoc.show-spring-cloud-functions=true

The Show spring cloud functions.

org.springdoc.core.properties.SpringDocConfigProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

springdoc.show-spring-cloud-functions=true

CAS properties can be specified using the YAML syntax:

springdoc: 
  show-spring-cloud-functions: "true"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspringdoc.show-spring-cloud-functions="true" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRINGDOC_SHOW_SPRING_CLOUD_FUNCTIONS="true"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --springdoc.show-spring-cloud-functions="true"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

springdoc.sort-converter.enabled=false

The Enabled.

org.springdoc.core.properties.SpringDocConfigProperties$SortConverter.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

springdoc.sort-converter.enabled=...

CAS properties can be specified using the YAML syntax:

springdoc: 
  sort-converter: 
    enabled: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspringdoc.sort-converter.enabled="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRINGDOC_SORT_CONVERTER_ENABLED="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --springdoc.sort-converter.enabled="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

springdoc.swagger-ui.config-url=

URL to fetch external configuration document from.

org.springdoc.core.properties.SwaggerUiConfigProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

springdoc.swagger-ui.config-url=...

CAS properties can be specified using the YAML syntax:

springdoc: 
  swagger-ui: 
    config-url: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspringdoc.swagger-ui.config-url="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRINGDOC_SWAGGER_UI_CONFIG_URL="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --springdoc.swagger-ui.config-url="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

springdoc.swagger-ui.csrf.cookie-name=

The Cookie name.

org.springdoc.core.properties.SwaggerUiConfigProperties$Csrf.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

springdoc.swagger-ui.csrf.cookie-name=...

CAS properties can be specified using the YAML syntax:

springdoc: 
  swagger-ui: 
    csrf: 
      cookie-name: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspringdoc.swagger-ui.csrf.cookie-name="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRINGDOC_SWAGGER_UI_CSRF_COOKIE_NAME="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --springdoc.swagger-ui.csrf.cookie-name="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

springdoc.swagger-ui.csrf.enabled=false

The Enabled.

org.springdoc.core.properties.SwaggerUiConfigProperties$Csrf.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

springdoc.swagger-ui.csrf.enabled=...

CAS properties can be specified using the YAML syntax:

springdoc: 
  swagger-ui: 
    csrf: 
      enabled: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspringdoc.swagger-ui.csrf.enabled="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRINGDOC_SWAGGER_UI_CSRF_ENABLED="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --springdoc.swagger-ui.csrf.enabled="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

springdoc.swagger-ui.csrf.header-name=

The Header name.

org.springdoc.core.properties.SwaggerUiConfigProperties$Csrf.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

springdoc.swagger-ui.csrf.header-name=...

CAS properties can be specified using the YAML syntax:

springdoc: 
  swagger-ui: 
    csrf: 
      header-name: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspringdoc.swagger-ui.csrf.header-name="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRINGDOC_SWAGGER_UI_CSRF_HEADER_NAME="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --springdoc.swagger-ui.csrf.header-name="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

springdoc.swagger-ui.csrf.local-storage-key=

The Local storage key.

org.springdoc.core.properties.SwaggerUiConfigProperties$Csrf.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

springdoc.swagger-ui.csrf.local-storage-key=...

CAS properties can be specified using the YAML syntax:

springdoc: 
  swagger-ui: 
    csrf: 
      local-storage-key: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspringdoc.swagger-ui.csrf.local-storage-key="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRINGDOC_SWAGGER_UI_CSRF_LOCAL_STORAGE_KEY="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --springdoc.swagger-ui.csrf.local-storage-key="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

springdoc.swagger-ui.csrf.session-storage-key=

The Session storage key.

org.springdoc.core.properties.SwaggerUiConfigProperties$Csrf.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

springdoc.swagger-ui.csrf.session-storage-key=...

CAS properties can be specified using the YAML syntax:

springdoc: 
  swagger-ui: 
    csrf: 
      session-storage-key: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspringdoc.swagger-ui.csrf.session-storage-key="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRINGDOC_SWAGGER_UI_CSRF_SESSION_STORAGE_KEY="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --springdoc.swagger-ui.csrf.session-storage-key="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

springdoc.swagger-ui.csrf.use-local-storage=false

Use Local storage.

org.springdoc.core.properties.SwaggerUiConfigProperties$Csrf.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

springdoc.swagger-ui.csrf.use-local-storage=...

CAS properties can be specified using the YAML syntax:

springdoc: 
  swagger-ui: 
    csrf: 
      use-local-storage: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspringdoc.swagger-ui.csrf.use-local-storage="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRINGDOC_SWAGGER_UI_CSRF_USE_LOCAL_STORAGE="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --springdoc.swagger-ui.csrf.use-local-storage="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

springdoc.swagger-ui.csrf.use-session-storage=false

Use Session storage.

org.springdoc.core.properties.SwaggerUiConfigProperties$Csrf.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

springdoc.swagger-ui.csrf.use-session-storage=...

CAS properties can be specified using the YAML syntax:

springdoc: 
  swagger-ui: 
    csrf: 
      use-session-storage: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspringdoc.swagger-ui.csrf.use-session-storage="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRINGDOC_SWAGGER_UI_CSRF_USE_SESSION_STORAGE="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --springdoc.swagger-ui.csrf.use-session-storage="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

springdoc.swagger-ui.deep-linking=

Enables or disables deep linking for tags and operations. @see deep-linking.md

org.springdoc.core.properties.SwaggerUiConfigProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

springdoc.swagger-ui.deep-linking=...

CAS properties can be specified using the YAML syntax:

springdoc: 
  swagger-ui: 
    deep-linking: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspringdoc.swagger-ui.deep-linking="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRINGDOC_SWAGGER_UI_DEEP_LINKING="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --springdoc.swagger-ui.deep-linking="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

springdoc.swagger-ui.default-model-expand-depth=

The default expansion depth for the model on the model-example section.

org.springdoc.core.properties.SwaggerUiConfigProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

springdoc.swagger-ui.default-model-expand-depth=...

CAS properties can be specified using the YAML syntax:

springdoc: 
  swagger-ui: 
    default-model-expand-depth: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspringdoc.swagger-ui.default-model-expand-depth="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRINGDOC_SWAGGER_UI_DEFAULT_MODEL_EXPAND_DEPTH="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --springdoc.swagger-ui.default-model-expand-depth="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

springdoc.swagger-ui.default-model-rendering=

Controls how the model is shown when the API is first rendered.

org.springdoc.core.properties.SwaggerUiConfigProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

springdoc.swagger-ui.default-model-rendering=...

CAS properties can be specified using the YAML syntax:

springdoc: 
  swagger-ui: 
    default-model-rendering: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspringdoc.swagger-ui.default-model-rendering="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRINGDOC_SWAGGER_UI_DEFAULT_MODEL_RENDERING="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --springdoc.swagger-ui.default-model-rendering="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

springdoc.swagger-ui.default-models-expand-depth=

The default expansion depth for models (set to -1 completely hide the models).

org.springdoc.core.properties.SwaggerUiConfigProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

springdoc.swagger-ui.default-models-expand-depth=...

CAS properties can be specified using the YAML syntax:

springdoc: 
  swagger-ui: 
    default-models-expand-depth: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspringdoc.swagger-ui.default-models-expand-depth="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRINGDOC_SWAGGER_UI_DEFAULT_MODELS_EXPAND_DEPTH="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --springdoc.swagger-ui.default-models-expand-depth="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

springdoc.swagger-ui.disable-swagger-default-url=false

The Disable swagger default url.

org.springdoc.core.properties.SwaggerUiConfigProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

springdoc.swagger-ui.disable-swagger-default-url=...

CAS properties can be specified using the YAML syntax:

springdoc: 
  swagger-ui: 
    disable-swagger-default-url: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspringdoc.swagger-ui.disable-swagger-default-url="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRINGDOC_SWAGGER_UI_DISABLE_SWAGGER_DEFAULT_URL="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --springdoc.swagger-ui.disable-swagger-default-url="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

springdoc.swagger-ui.display-operation-id=

Controls the display of operationId in operations list.

org.springdoc.core.properties.SwaggerUiConfigProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

springdoc.swagger-ui.display-operation-id=...

CAS properties can be specified using the YAML syntax:

springdoc: 
  swagger-ui: 
    display-operation-id: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspringdoc.swagger-ui.display-operation-id="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRINGDOC_SWAGGER_UI_DISPLAY_OPERATION_ID="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --springdoc.swagger-ui.display-operation-id="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

springdoc.swagger-ui.display-request-duration=

Controls the display of the request duration (in milliseconds) for Try-It-Out requests.

org.springdoc.core.properties.SwaggerUiConfigProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

springdoc.swagger-ui.display-request-duration=...

CAS properties can be specified using the YAML syntax:

springdoc: 
  swagger-ui: 
    display-request-duration: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspringdoc.swagger-ui.display-request-duration="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRINGDOC_SWAGGER_UI_DISPLAY_REQUEST_DURATION="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --springdoc.swagger-ui.display-request-duration="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

springdoc.swagger-ui.doc-expansion=

Controls the default expansion setting for the operations and tags.

org.springdoc.core.properties.SwaggerUiConfigProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

springdoc.swagger-ui.doc-expansion=...

CAS properties can be specified using the YAML syntax:

springdoc: 
  swagger-ui: 
    doc-expansion: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspringdoc.swagger-ui.doc-expansion="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRINGDOC_SWAGGER_UI_DOC_EXPANSION="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --springdoc.swagger-ui.doc-expansion="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

springdoc.swagger-ui.enabled=true

Whether to generate and serve an OpenAPI document.

org.springdoc.core.properties.SwaggerUiConfigProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

springdoc.swagger-ui.enabled=true

CAS properties can be specified using the YAML syntax:

springdoc: 
  swagger-ui: 
    enabled: "true"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspringdoc.swagger-ui.enabled="true" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRINGDOC_SWAGGER_UI_ENABLED="true"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --springdoc.swagger-ui.enabled="true"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

springdoc.swagger-ui.filter=

If set, enables filtering. The top bar will show an edit box that could be used to filter the tagged operations that are shown.

org.springdoc.core.properties.SwaggerUiConfigProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

springdoc.swagger-ui.filter=...

CAS properties can be specified using the YAML syntax:

springdoc: 
  swagger-ui: 
    filter: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspringdoc.swagger-ui.filter="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRINGDOC_SWAGGER_UI_FILTER="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --springdoc.swagger-ui.filter="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

springdoc.swagger-ui.groups-order=asc

The Groups order.

org.springdoc.core.properties.SwaggerUiConfigProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

springdoc.swagger-ui.groups-order=asc

CAS properties can be specified using the YAML syntax:

springdoc: 
  swagger-ui: 
    groups-order: "asc"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspringdoc.swagger-ui.groups-order="asc" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRINGDOC_SWAGGER_UI_GROUPS_ORDER="asc"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --springdoc.swagger-ui.groups-order="asc"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

springdoc.swagger-ui.layout=

The name of a component available via the plugin system to use as the top-level layout for Swagger UI.

org.springdoc.core.properties.SwaggerUiConfigProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

springdoc.swagger-ui.layout=...

CAS properties can be specified using the YAML syntax:

springdoc: 
  swagger-ui: 
    layout: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspringdoc.swagger-ui.layout="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRINGDOC_SWAGGER_UI_LAYOUT="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --springdoc.swagger-ui.layout="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

springdoc.swagger-ui.max-displayed-tags=

If set, limits the number of tagged operations displayed to at most this many.

org.springdoc.core.properties.SwaggerUiConfigProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

springdoc.swagger-ui.max-displayed-tags=...

CAS properties can be specified using the YAML syntax:

springdoc: 
  swagger-ui: 
    max-displayed-tags: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspringdoc.swagger-ui.max-displayed-tags="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRINGDOC_SWAGGER_UI_MAX_DISPLAYED_TAGS="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --springdoc.swagger-ui.max-displayed-tags="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

springdoc.swagger-ui.oauth.additional-query-string-params=

The Additional query string params.

org.springdoc.core.properties.SwaggerUiOAuthProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

springdoc.swagger-ui.oauth.additional-query-string-params=...

CAS properties can be specified using the YAML syntax:

springdoc: 
  swagger-ui: 
    oauth: 
      additional-query-string-params: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspringdoc.swagger-ui.oauth.additional-query-string-params="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRINGDOC_SWAGGER_UI_OAUTH_ADDITIONAL_QUERY_STRING_PARAMS="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --springdoc.swagger-ui.oauth.additional-query-string-params="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

springdoc.swagger-ui.oauth.app-name=

The App name.

org.springdoc.core.properties.SwaggerUiOAuthProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

springdoc.swagger-ui.oauth.app-name=...

CAS properties can be specified using the YAML syntax:

springdoc: 
  swagger-ui: 
    oauth: 
      app-name: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspringdoc.swagger-ui.oauth.app-name="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRINGDOC_SWAGGER_UI_OAUTH_APP_NAME="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --springdoc.swagger-ui.oauth.app-name="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

springdoc.swagger-ui.oauth.client-id=

The Client id.

org.springdoc.core.properties.SwaggerUiOAuthProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

springdoc.swagger-ui.oauth.client-id=...

CAS properties can be specified using the YAML syntax:

springdoc: 
  swagger-ui: 
    oauth: 
      client-id: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspringdoc.swagger-ui.oauth.client-id="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRINGDOC_SWAGGER_UI_OAUTH_CLIENT_ID="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --springdoc.swagger-ui.oauth.client-id="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

springdoc.swagger-ui.oauth.client-secret=

The Client secret.

org.springdoc.core.properties.SwaggerUiOAuthProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

springdoc.swagger-ui.oauth.client-secret=...

CAS properties can be specified using the YAML syntax:

springdoc: 
  swagger-ui: 
    oauth: 
      client-secret: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspringdoc.swagger-ui.oauth.client-secret="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRINGDOC_SWAGGER_UI_OAUTH_CLIENT_SECRET="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --springdoc.swagger-ui.oauth.client-secret="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

springdoc.swagger-ui.oauth.config-parameters=

org.springdoc.core.properties.SwaggerUiOAuthProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

springdoc.swagger-ui.oauth.config-parameters=...

CAS properties can be specified using the YAML syntax:

springdoc: 
  swagger-ui: 
    oauth: 
      config-parameters: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspringdoc.swagger-ui.oauth.config-parameters="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRINGDOC_SWAGGER_UI_OAUTH_CONFIG_PARAMETERS="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --springdoc.swagger-ui.oauth.config-parameters="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

springdoc.swagger-ui.oauth.realm=

The Realm.

org.springdoc.core.properties.SwaggerUiOAuthProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

springdoc.swagger-ui.oauth.realm=...

CAS properties can be specified using the YAML syntax:

springdoc: 
  swagger-ui: 
    oauth: 
      realm: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspringdoc.swagger-ui.oauth.realm="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRINGDOC_SWAGGER_UI_OAUTH_REALM="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --springdoc.swagger-ui.oauth.realm="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

springdoc.swagger-ui.oauth.scope-separator=

The Scope separator.

org.springdoc.core.properties.SwaggerUiOAuthProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

springdoc.swagger-ui.oauth.scope-separator=...

CAS properties can be specified using the YAML syntax:

springdoc: 
  swagger-ui: 
    oauth: 
      scope-separator: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspringdoc.swagger-ui.oauth.scope-separator="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRINGDOC_SWAGGER_UI_OAUTH_SCOPE_SEPARATOR="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --springdoc.swagger-ui.oauth.scope-separator="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

springdoc.swagger-ui.oauth.scopes=

The Scopes selected by default upon authentication.

org.springdoc.core.properties.SwaggerUiOAuthProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

springdoc.swagger-ui.oauth.scopes=...

CAS properties can be specified using the YAML syntax:

springdoc: 
  swagger-ui: 
    oauth: 
      scopes: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspringdoc.swagger-ui.oauth.scopes="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRINGDOC_SWAGGER_UI_OAUTH_SCOPES="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --springdoc.swagger-ui.oauth.scopes="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

springdoc.swagger-ui.oauth.use-basic-authentication-with-access-code-grant=

The Use basic authentication with access code grant.

org.springdoc.core.properties.SwaggerUiOAuthProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

springdoc.swagger-ui.oauth.use-basic-authentication-with-access-code-grant=...

CAS properties can be specified using the YAML syntax:

springdoc: 
  swagger-ui: 
    oauth: 
      use-basic-authentication-with-access-code-grant: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspringdoc.swagger-ui.oauth.use-basic-authentication-with-access-code-grant="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRINGDOC_SWAGGER_UI_OAUTH_USE_BASIC_AUTHENTICATION_WITH_ACCESS_CODE_GRANT="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --springdoc.swagger-ui.oauth.use-basic-authentication-with-access-code-grant="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

springdoc.swagger-ui.oauth.use-pkce-with-authorization-code-grant=

The Use pkce with authorization code grant.

org.springdoc.core.properties.SwaggerUiOAuthProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

springdoc.swagger-ui.oauth.use-pkce-with-authorization-code-grant=...

CAS properties can be specified using the YAML syntax:

springdoc: 
  swagger-ui: 
    oauth: 
      use-pkce-with-authorization-code-grant: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspringdoc.swagger-ui.oauth.use-pkce-with-authorization-code-grant="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRINGDOC_SWAGGER_UI_OAUTH_USE_PKCE_WITH_AUTHORIZATION_CODE_GRANT="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --springdoc.swagger-ui.oauth.use-pkce-with-authorization-code-grant="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

springdoc.swagger-ui.oauth2-redirect-url=

OAuth redirect URL.

org.springdoc.core.properties.SwaggerUiConfigProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

springdoc.swagger-ui.oauth2-redirect-url=...

CAS properties can be specified using the YAML syntax:

springdoc: 
  swagger-ui: 
    oauth2-redirect-url: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspringdoc.swagger-ui.oauth2-redirect-url="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRINGDOC_SWAGGER_UI_OAUTH2_REDIRECT_URL="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --springdoc.swagger-ui.oauth2-redirect-url="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

springdoc.swagger-ui.operations-sorter=

Apply a sort to the operation list of each API

org.springdoc.core.properties.SwaggerUiConfigProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

springdoc.swagger-ui.operations-sorter=...

CAS properties can be specified using the YAML syntax:

springdoc: 
  swagger-ui: 
    operations-sorter: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspringdoc.swagger-ui.operations-sorter="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRINGDOC_SWAGGER_UI_OPERATIONS_SORTER="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --springdoc.swagger-ui.operations-sorter="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

springdoc.swagger-ui.path=

The path for the Swagger UI pages to load. Will redirect to the springdoc.webjars.prefix property.

org.springdoc.core.properties.SwaggerUiConfigProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

springdoc.swagger-ui.path=...

CAS properties can be specified using the YAML syntax:

springdoc: 
  swagger-ui: 
    path: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspringdoc.swagger-ui.path="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRINGDOC_SWAGGER_UI_PATH="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --springdoc.swagger-ui.path="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

springdoc.swagger-ui.persist-authorization=

The Persist authorization.

org.springdoc.core.properties.SwaggerUiConfigProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

springdoc.swagger-ui.persist-authorization=...

CAS properties can be specified using the YAML syntax:

springdoc: 
  swagger-ui: 
    persist-authorization: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspringdoc.swagger-ui.persist-authorization="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRINGDOC_SWAGGER_UI_PERSIST_AUTHORIZATION="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --springdoc.swagger-ui.persist-authorization="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

springdoc.swagger-ui.query-config-enabled=

The Query config enabled.

org.springdoc.core.properties.SwaggerUiConfigProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

springdoc.swagger-ui.query-config-enabled=...

CAS properties can be specified using the YAML syntax:

springdoc: 
  swagger-ui: 
    query-config-enabled: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspringdoc.swagger-ui.query-config-enabled="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRINGDOC_SWAGGER_UI_QUERY_CONFIG_ENABLED="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --springdoc.swagger-ui.query-config-enabled="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

springdoc.swagger-ui.show-common-extensions=

Controls the display of extensions

org.springdoc.core.properties.SwaggerUiConfigProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

springdoc.swagger-ui.show-common-extensions=...

CAS properties can be specified using the YAML syntax:

springdoc: 
  swagger-ui: 
    show-common-extensions: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspringdoc.swagger-ui.show-common-extensions="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRINGDOC_SWAGGER_UI_SHOW_COMMON_EXTENSIONS="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --springdoc.swagger-ui.show-common-extensions="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

springdoc.swagger-ui.show-extensions=

Controls the display of vendor extension (x-) fields and values.

org.springdoc.core.properties.SwaggerUiConfigProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

springdoc.swagger-ui.show-extensions=...

CAS properties can be specified using the YAML syntax:

springdoc: 
  swagger-ui: 
    show-extensions: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspringdoc.swagger-ui.show-extensions="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRINGDOC_SWAGGER_UI_SHOW_EXTENSIONS="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --springdoc.swagger-ui.show-extensions="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

springdoc.swagger-ui.supported-submit-methods=

The supported try it out methods

org.springdoc.core.properties.SwaggerUiConfigProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

springdoc.swagger-ui.supported-submit-methods=...

CAS properties can be specified using the YAML syntax:

springdoc: 
  swagger-ui: 
    supported-submit-methods: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspringdoc.swagger-ui.supported-submit-methods="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRINGDOC_SWAGGER_UI_SUPPORTED_SUBMIT_METHODS="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --springdoc.swagger-ui.supported-submit-methods="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

springdoc.swagger-ui.syntax-highlight.activated=

The Activated.

org.springdoc.core.properties.SwaggerUiConfigProperties$SyntaxHighlight.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

springdoc.swagger-ui.syntax-highlight.activated=...

CAS properties can be specified using the YAML syntax:

springdoc: 
  swagger-ui: 
    syntax-highlight: 
      activated: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspringdoc.swagger-ui.syntax-highlight.activated="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRINGDOC_SWAGGER_UI_SYNTAX_HIGHLIGHT_ACTIVATED="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --springdoc.swagger-ui.syntax-highlight.activated="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

springdoc.swagger-ui.syntax-highlight.theme=

The Theme.

org.springdoc.core.properties.SwaggerUiConfigProperties$SyntaxHighlight.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

springdoc.swagger-ui.syntax-highlight.theme=...

CAS properties can be specified using the YAML syntax:

springdoc: 
  swagger-ui: 
    syntax-highlight: 
      theme: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspringdoc.swagger-ui.syntax-highlight.theme="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRINGDOC_SWAGGER_UI_SYNTAX_HIGHLIGHT_THEME="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --springdoc.swagger-ui.syntax-highlight.theme="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

springdoc.swagger-ui.tags-sorter=

Apply a sort to the tag list of each API

org.springdoc.core.properties.SwaggerUiConfigProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

springdoc.swagger-ui.tags-sorter=...

CAS properties can be specified using the YAML syntax:

springdoc: 
  swagger-ui: 
    tags-sorter: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspringdoc.swagger-ui.tags-sorter="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRINGDOC_SWAGGER_UI_TAGS_SORTER="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --springdoc.swagger-ui.tags-sorter="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

springdoc.swagger-ui.try-it-out-enabled=

Try it out enabled

org.springdoc.core.properties.SwaggerUiConfigProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

springdoc.swagger-ui.try-it-out-enabled=...

CAS properties can be specified using the YAML syntax:

springdoc: 
  swagger-ui: 
    try-it-out-enabled: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspringdoc.swagger-ui.try-it-out-enabled="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRINGDOC_SWAGGER_UI_TRY_IT_OUT_ENABLED="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --springdoc.swagger-ui.try-it-out-enabled="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

springdoc.swagger-ui.url=

The Url.

org.springdoc.core.properties.SwaggerUiConfigProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

springdoc.swagger-ui.url=...

CAS properties can be specified using the YAML syntax:

springdoc: 
  swagger-ui: 
    url: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspringdoc.swagger-ui.url="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRINGDOC_SWAGGER_UI_URL="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --springdoc.swagger-ui.url="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

springdoc.swagger-ui.urls=

The Urls.

org.springdoc.core.properties.SwaggerUiConfigProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

springdoc.swagger-ui.urls=...

CAS properties can be specified using the YAML syntax:

springdoc: 
  swagger-ui: 
    urls: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspringdoc.swagger-ui.urls="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRINGDOC_SWAGGER_UI_URLS="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --springdoc.swagger-ui.urls="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

springdoc.swagger-ui.urls-primary-name=

The Urls primary name.

org.springdoc.core.properties.SwaggerUiConfigProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

springdoc.swagger-ui.urls-primary-name=...

CAS properties can be specified using the YAML syntax:

springdoc: 
  swagger-ui: 
    urls-primary-name: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspringdoc.swagger-ui.urls-primary-name="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRINGDOC_SWAGGER_UI_URLS_PRIMARY_NAME="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --springdoc.swagger-ui.urls-primary-name="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

springdoc.swagger-ui.use-root-path=false

The Use root path.

org.springdoc.core.properties.SwaggerUiConfigProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

springdoc.swagger-ui.use-root-path=...

CAS properties can be specified using the YAML syntax:

springdoc: 
  swagger-ui: 
    use-root-path: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspringdoc.swagger-ui.use-root-path="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRINGDOC_SWAGGER_UI_USE_ROOT_PATH="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --springdoc.swagger-ui.use-root-path="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

springdoc.swagger-ui.validator-url=

URL to validate specs against.

org.springdoc.core.properties.SwaggerUiConfigProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

springdoc.swagger-ui.validator-url=...

CAS properties can be specified using the YAML syntax:

springdoc: 
  swagger-ui: 
    validator-url: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspringdoc.swagger-ui.validator-url="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRINGDOC_SWAGGER_UI_VALIDATOR_URL="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --springdoc.swagger-ui.validator-url="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

springdoc.swagger-ui.version=

The Swagger ui version.

org.springdoc.core.properties.SwaggerUiConfigProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

springdoc.swagger-ui.version=...

CAS properties can be specified using the YAML syntax:

springdoc: 
  swagger-ui: 
    version: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspringdoc.swagger-ui.version="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRINGDOC_SWAGGER_UI_VERSION="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --springdoc.swagger-ui.version="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

springdoc.swagger-ui.with-credentials=

The With credentials.

org.springdoc.core.properties.SwaggerUiConfigProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

springdoc.swagger-ui.with-credentials=...

CAS properties can be specified using the YAML syntax:

springdoc: 
  swagger-ui: 
    with-credentials: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspringdoc.swagger-ui.with-credentials="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRINGDOC_SWAGGER_UI_WITH_CREDENTIALS="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --springdoc.swagger-ui.with-credentials="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

springdoc.trim-kotlin-indent=false

The trim kotlin indent.

org.springdoc.core.properties.SpringDocConfigProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

springdoc.trim-kotlin-indent=...

CAS properties can be specified using the YAML syntax:

springdoc: 
  trim-kotlin-indent: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspringdoc.trim-kotlin-indent="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRINGDOC_TRIM_KOTLIN_INDENT="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --springdoc.trim-kotlin-indent="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

springdoc.use-fqn=false

Use fully qualified name

org.springdoc.core.properties.SpringDocConfigProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

springdoc.use-fqn=...

CAS properties can be specified using the YAML syntax:

springdoc: 
  use-fqn: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspringdoc.use-fqn="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRINGDOC_USE_FQN="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --springdoc.use-fqn="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

springdoc.use-management-port=false

If set to true, exposes the swagger-ui on the actuator management port.

org.springdoc.core.properties.SpringDocConfigProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

springdoc.use-management-port=...

CAS properties can be specified using the YAML syntax:

springdoc: 
  use-management-port: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspringdoc.use-management-port="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRINGDOC_USE_MANAGEMENT_PORT="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --springdoc.use-management-port="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

springdoc.webjars.prefix=

The Prefix.

org.springdoc.core.properties.SpringDocConfigProperties$Webjars.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

springdoc.webjars.prefix=...

CAS properties can be specified using the YAML syntax:

springdoc: 
  webjars: 
    prefix: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspringdoc.webjars.prefix="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRINGDOC_WEBJARS_PREFIX="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --springdoc.webjars.prefix="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

springdoc.writer-with-default-pretty-printer=false

The Writer with default pretty printer.

org.springdoc.core.properties.SpringDocConfigProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

springdoc.writer-with-default-pretty-printer=...

CAS properties can be specified using the YAML syntax:

springdoc: 
  writer-with-default-pretty-printer: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspringdoc.writer-with-default-pretty-printer="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRINGDOC_WRITER_WITH_DEFAULT_PRETTY_PRINTER="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --springdoc.writer-with-default-pretty-printer="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

springdoc.writer-with-order-by-keys=false

The Writer with order by keys.

org.springdoc.core.properties.SpringDocConfigProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

springdoc.writer-with-order-by-keys=...

CAS properties can be specified using the YAML syntax:

springdoc: 
  writer-with-order-by-keys: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspringdoc.writer-with-order-by-keys="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRINGDOC_WRITER_WITH_ORDER_BY_KEYS="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --springdoc.writer-with-order-by-keys="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

# Whether to generate and serve an OpenAPI document.
# springdoc.api-docs.enabled=true

# The Enabled.
# springdoc.api-docs.groups.enabled=false

# Path to the generated OpenAPI documentation.
# springdoc.api-docs.path=

# The Resolve extensions properties.
# springdoc.api-docs.resolve-extensions-properties=false

# The Resolve schema properties.
# springdoc.api-docs.resolve-schema-properties=false

# The OpenAPI version.
# springdoc.api-docs.version=

# The Auto tag classes.
# springdoc.auto-tag-classes=true

# The Disabled.
# springdoc.cache.disabled=false

# The Consumes to match.
# springdoc.consumes-to-match=

# The Default consumes media type.
# springdoc.default-consumes-media-type=

# The param default flatten
# springdoc.default-flat-param-object=false

# The Default produces media type.
# springdoc.default-produces-media-type=

# convert query param to form data when consumes is multipart/form-data
# springdoc.default-support-form-data=false

# The Disable i18n.
# springdoc.disable-i18n=false

# The Enable hateoas.
# springdoc.enable-data-rest=true

# The Enable default api docs.
# springdoc.enable-default-api-docs=true

# The Enable groovy.
# springdoc.enable-groovy=true

# The Enable hateoas.
# springdoc.enable-hateoas=true

# The Enable javadoc.
# springdoc.enable-javadoc=true

# The Enable kotlin.
# springdoc.enable-kotlin=true

# The Enable spring security.
# springdoc.enable-spring-security=true

# The Group configs.
# springdoc.group-configs=

# The Headers to match.
# springdoc.headers-to-match=

# The Model and view allowed.
# springdoc.model-and-view-allowed=false

# The Enabled.
# springdoc.model-converters.deprecating-converter.enabled=false

# The Enabled.
# springdoc.model-converters.pageable-converter.enabled=false

# The Enabled.
# springdoc.model-converters.polymorphic-converter.enabled=false

# The Nullable request parameter enabled.
# springdoc.nullable-request-parameter-enabled=false

# 
# springdoc.open-api=

# The Override with generic response.
# springdoc.override-with-generic-response=

# The Packages to exclude.
# springdoc.packages-to-exclude=

# The Packages to scan.
# springdoc.packages-to-scan=

# The Paths to exclude.
# springdoc.paths-to-exclude=

# The Paths to match.
# springdoc.paths-to-match=

# Allow for pre-loading OpenAPI
# springdoc.pre-loading-enabled=false

# locale list to pre-loading
# springdoc.pre-loading-locales=

# The Produces to match.
# springdoc.produces-to-match=

# The Remove broken reference definitions.
# springdoc.remove-broken-reference-definitions=true

# The Show actuator.
# springdoc.show-actuator=false

# The Show login endpoint.
# springdoc.show-login-endpoint=false

# The Show oauth 2 endpoint.
# springdoc.show-oauth2-endpoints=false

# The Show spring cloud functions.
# springdoc.show-spring-cloud-functions=true

# The Enabled.
# springdoc.sort-converter.enabled=false

# URL to fetch external configuration document from.
# springdoc.swagger-ui.config-url=

# The Cookie name.
# springdoc.swagger-ui.csrf.cookie-name=

# The Enabled.
# springdoc.swagger-ui.csrf.enabled=false

# The Header name.
# springdoc.swagger-ui.csrf.header-name=

# The Local storage key.
# springdoc.swagger-ui.csrf.local-storage-key=

# The Session storage key.
# springdoc.swagger-ui.csrf.session-storage-key=

# Use Local storage.
# springdoc.swagger-ui.csrf.use-local-storage=false

# Use Session storage.
# springdoc.swagger-ui.csrf.use-session-storage=false

# Enables or disables deep linking for tags and operations.
# springdoc.swagger-ui.deep-linking=

# The default expansion depth for the model on the model-example section.
# springdoc.swagger-ui.default-model-expand-depth=

# Controls how the model is shown when the API is first rendered.
# springdoc.swagger-ui.default-model-rendering=

# The default expansion depth for models (set to -1 completely hide the models).
# springdoc.swagger-ui.default-models-expand-depth=

# The Disable swagger default url.
# springdoc.swagger-ui.disable-swagger-default-url=false

# Controls the display of operationId in operations list.
# springdoc.swagger-ui.display-operation-id=

# Controls the display of the request duration (in milliseconds) for Try-It-Out requests.
# springdoc.swagger-ui.display-request-duration=

# Controls the default expansion setting for the operations and tags.
# springdoc.swagger-ui.doc-expansion=

# Whether to generate and serve an OpenAPI document.
# springdoc.swagger-ui.enabled=true

# If set, enables filtering.
# springdoc.swagger-ui.filter=

# The Groups order.
# springdoc.swagger-ui.groups-order=asc

# The name of a component available via the plugin system to use as the top-level layout for Swagger UI.
# springdoc.swagger-ui.layout=

# If set, limits the number of tagged operations displayed to at most this many.
# springdoc.swagger-ui.max-displayed-tags=

# The Additional query string params.
# springdoc.swagger-ui.oauth.additional-query-string-params=

# The App name.
# springdoc.swagger-ui.oauth.app-name=

# The Client id.
# springdoc.swagger-ui.oauth.client-id=

# The Client secret.
# springdoc.swagger-ui.oauth.client-secret=

# 
# springdoc.swagger-ui.oauth.config-parameters=

# The Realm.
# springdoc.swagger-ui.oauth.realm=

# The Scope separator.
# springdoc.swagger-ui.oauth.scope-separator=

# The Scopes selected by default upon authentication.
# springdoc.swagger-ui.oauth.scopes=

# The Use basic authentication with access code grant.
# springdoc.swagger-ui.oauth.use-basic-authentication-with-access-code-grant=

# The Use pkce with authorization code grant.
# springdoc.swagger-ui.oauth.use-pkce-with-authorization-code-grant=

# OAuth redirect URL.
# springdoc.swagger-ui.oauth2-redirect-url=

# Apply a sort to the operation list of each API
# springdoc.swagger-ui.operations-sorter=

# The path for the Swagger UI pages to load.
# springdoc.swagger-ui.path=

# The Persist authorization.
# springdoc.swagger-ui.persist-authorization=

# The Query config enabled.
# springdoc.swagger-ui.query-config-enabled=

# Controls the display of extensions
# springdoc.swagger-ui.show-common-extensions=

# Controls the display of vendor extension (x-) fields and values.
# springdoc.swagger-ui.show-extensions=

# The supported try it out methods
# springdoc.swagger-ui.supported-submit-methods=

# The Activated.
# springdoc.swagger-ui.syntax-highlight.activated=

# The Theme.
# springdoc.swagger-ui.syntax-highlight.theme=

# Apply a sort to the tag list of each API
# springdoc.swagger-ui.tags-sorter=

# Try it out enabled
# springdoc.swagger-ui.try-it-out-enabled=

# The Url.
# springdoc.swagger-ui.url=

# The Urls.
# springdoc.swagger-ui.urls=

# The Urls primary name.
# springdoc.swagger-ui.urls-primary-name=

# The Use root path.
# springdoc.swagger-ui.use-root-path=false

# URL to validate specs against.
# springdoc.swagger-ui.validator-url=

# The Swagger ui version.
# springdoc.swagger-ui.version=

# The With credentials.
# springdoc.swagger-ui.with-credentials=

# The trim kotlin indent.
# springdoc.trim-kotlin-indent=false

# Use fully qualified name
# springdoc.use-fqn=false

# If set to true, exposes the swagger-ui on the actuator management port.
# springdoc.use-management-port=false

# The Prefix.
# springdoc.webjars.prefix=

# The Writer with default pretty printer.
# springdoc.writer-with-default-pretty-printer=false

# The Writer with order by keys.
# springdoc.writer-with-order-by-keys=false

Configuration Metadata

The collection of configuration properties listed in this section are automatically generated from the CAS source and components that contain the actual field definitions, types, descriptions, modules, etc. This metadata may not always be 100% accurate, or could be lacking details and sufficient explanations.

Be Selective

This section is meant as a guide only. Do NOT copy/paste the entire collection of settings into your CAS configuration; rather pick only the properties that you need. Do NOT enable settings unless you are certain of their purpose and do NOT copy settings into your configuration only to keep them as reference. All these ideas lead to upgrade headaches, maintenance nightmares and premature aging.

YAGNI

Note that for nearly ALL use cases, declaring and configuring properties listed here is sufficient. You should NOT have to explicitly massage a CAS XML/Java/etc configuration file to design an authentication handler, create attribute release policies, etc. CAS at runtime will auto-configure all required changes for you. If you are unsure about the meaning of a given CAS setting, do NOT turn it on without hesitation. Review the codebase or better yet, ask questions to clarify the intended behavior.

Naming Convention

Property names can be specified in very relaxed terms. For instance cas.someProperty, cas.some-property, cas.some_property are all valid names. While all forms are accepted by CAS, there are certain components (in CAS and other frameworks used) whose activation at runtime is conditional on a property value, where this property is required to have been specified in CAS configuration using kebab case. This is both true for properties that are owned by CAS as well as those that might be presented to the system via an external library or framework such as Spring Boot, etc.

Note

Settings and properties that are controlled by the CAS platform directly always begin with the prefix cas. All other settings are controlled and provided to CAS via other underlying frameworks and may have their own schemas and syntax. BE CAREFUL with the distinction. Unrecognized properties are rejected by CAS and/or frameworks upon which CAS depends. This means if you somehow misspell a property definition or fail to adhere to the dot-notation syntax and such, your setting is entirely refused by CAS and likely the feature it controls will never be activated in the way you intend.

Validation

Configuration properties are automatically validated on CAS startup to report issues with configuration binding, specially if defined CAS settings cannot be recognized or validated by the configuration schema. Additional validation processes are also handled via Configuration Metadata and property migrations applied automatically on startup by Spring Boot and family.

Indexed Settings

CAS settings able to accept multiple values are typically documented with an index, such as cas.some.setting[0]=value. The index [0] is meant to be incremented by the adopter to allow for distinct multiple configuration blocks.

Endpoints

The following Swagger endpoints may be used to analyze and test the APIs:

Description	URL
Swagger API Specification	`https://sso.example.org/cas/v3/api-docs`
Swagger UI	`https://sso.example.org/cas/swagger-ui.html`