Skip to content

Commit

Permalink
Added skip/exclude list for property docs generator
Browse files Browse the repository at this point in the history
  • Loading branch information
EricWittmann committed Jan 29, 2024
1 parent 4a90915 commit e75df57
Show file tree
Hide file tree
Showing 2 changed files with 55 additions and 0 deletions.
4 changes: 4 additions & 0 deletions docs/generateAllConfigPartial.java
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
public class generateAllConfigPartial {

private static Map<String, Option> allConfiguration = new HashMap();
private static Set<String> skipProperties = Set.of("registry.auth.url.configured");

static class Option {
final String name;
Expand Down Expand Up @@ -152,6 +153,9 @@ public static Map<String, Option> extractConfigurations(String jarFile, Map<Stri
if (allConfiguration.containsKey(configName)) {
continue;
}
if (skipProperties.contains(configName)) {
continue;
}
switch (annotation.target().kind()) {
case FIELD:
configName = configName.replace("app.authn.", "registry.auth.");
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -799,3 +799,54 @@ The following {registry} configuration options are available for each component
|Skip artifact versions with DISABLED state when retrieving latest artifact version
|===

== ui
.ui configuration options
[.table-expandable,width="100%",cols="6,3,2,3,5",options="header"]
|===
|Name
|Type
|Default
|Available from
|Description
|`registry.ui.auth.oidc.clientId`
|`string`
|`apicurio-registry-ui`
|`3.0.0`
|The OIDC clientId
|`registry.ui.auth.oidc.redirectUri`
|`string`
|`/`
|`3.0.0`
|The OIDC redirectUri
|`registry.ui.contextPath`
|`string`
|`/`
|`3.0.0`
|Context path of the UI
|`registry.ui.docsUrl`
|`string`
|`/docs/`
|`3.0.0`
|URL of the Documentation component
|`registry.ui.features.breadcrumbs`
|`string`
|`true`
|`3.0.0`
|Enabled to show breadcrumbs in the UI
|`registry.ui.features.readOnly`
|`string`
|`false`
|`3.0.0`
|Enabled to set the UI to read-only mode
|`registry.ui.features.settings`
|`string`
|`true`
|`3.0.0`
|Enabled to show the Settings tab in the UI
|`registry.ui.navPrefixPath`
|`string`
|`/`
|`3.0.0`
|Navigation prefix for all UI paths
|===

0 comments on commit e75df57

Please sign in to comment.