keycloak-scim/docs/guides/templates/options.adoc

<#macro expectedValues option>
    <#assign optionObj = ctx.options.getOption(option) />
    <#list optionObj.expectedValues as expectedValue>
        * ${expectedValue} <#if optionObj.defaultValue?has_content && expectedValue == optionObj.defaultValue> (default)</#if>
    </#list>
</#macro>

<#macro list options buildIcon=true anchor=true>
[cols="12a,4",role="options"]
|===
| |Value

<#list options as option>
|
[.options-key]#``${option.key}``# <#if buildIcon><#if option.build>[.none]#icon:tools[role=options-build]#</#if></#if>

[.options-description]#${option.description}#

[<#if anchor>#option-extended-${option.key},</#if>role="options-extended"]
--
<#if option.descriptionExtended?has_content>[.options-description-extended]#${option.descriptionExtended!}#</#if>

*CLI:* `${option.keyCli}` +
*Env:* `${option.keyEnv}`
--

<#if option.enabledWhen?has_content>
${option.enabledWhen!}
</#if>

<#if option.deprecated?has_content>
<#-- Either mark the whole option as deprecated, or just selected values -->
<#if !option.deprecated.deprecatedValues?has_content>
*DEPRECATED.*
</#if>
${option.deprecated.note!}<#if option.deprecated.newOptionsKeys?has_content><#if option.deprecated.note?has_content> </#if>Use: <#list option.deprecated.newOptionsKeys as key>`+${key}+`<#if key?has_next>, </#if></#list>.</#if>
<#if option.deprecated.deprecatedValues?has_content>
*Deprecated values: <#list option.deprecated.deprecatedValues as value>`+${value}+`<#if value?has_next>, </#if></#list>*
</#if>
</#if>

|<#if option.expectedValues?has_content>
<#list option.expectedValues as value>`+${value!}+`<#if option.defaultValue?has_content && value = option.defaultValue> (default)</#if><#if value?has_next>, </#if></#list><#if !option.strictExpectedValues>, or any</#if>
<#else>
<#if option.defaultValue?has_content>[.options-default]#`+${option.defaultValue!}+`# (default)</#if><#if option.type?has_content && option.defaultValue?has_content> or </#if><#if option.type?has_content && !option.expectedValues?has_content>any `+${option.type!}+`</#if>
</#if>

</#list>

|===
</#macro>