From 17ec63be2ddeaf8476ad8307dbdad860605ac7c0 Mon Sep 17 00:00:00 2001 From: Francesco Ilario Date: Thu, 27 Jun 2024 10:52:56 +0200 Subject: [PATCH] update apiref.doc Signed-off-by: Francesco Ilario --- api/v1alpha1/docs/apiref.adoc | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/api/v1alpha1/docs/apiref.adoc b/api/v1alpha1/docs/apiref.adoc index d9f942fb..f0753e5c 100644 --- a/api/v1alpha1/docs/apiref.adoc +++ b/api/v1alpha1/docs/apiref.adoc @@ -612,6 +612,10 @@ HostConfig contains all configuration parameters of the host operator | *`toolchainStatus`* __xref:{anchor_prefix}-github-com-codeready-toolchain-api-api-v1alpha1-toolchainstatusconfig[$$ToolchainStatusConfig$$]__ | Keeps parameters concerned with the toolchainstatus + | | | *`users`* __xref:{anchor_prefix}-github-com-codeready-toolchain-api-api-v1alpha1-usersconfig[$$UsersConfig$$]__ | Keeps parameters concerned with user management + | | | *`spaceConfig`* __xref:{anchor_prefix}-github-com-codeready-toolchain-api-api-v1alpha1-spaceconfig[$$SpaceConfig$$]__ | Keeps parameters necessary for configuring Space provisioning functionality + | | +| *`publicViewerConfig`* __xref:{anchor_prefix}-github-com-codeready-toolchain-api-api-v1alpha1-publicviewerconfiguration[$$PublicViewerConfiguration$$]__ | Contains the PublicViewer configuration. + +IMPORTANT: To provide a consistent User-Experience, each user + +the space has been directly shared with should have at least + +the same permissions the kubesaw-authenticated user has. + | | |=== @@ -1986,6 +1990,27 @@ Supported condition types: ConditionReady + | | |=== +[id="{anchor_prefix}-github-com-codeready-toolchain-api-api-v1alpha1-publicviewerconfiguration"] +==== PublicViewerConfiguration + + + +Configuration to enable the PublicViewer support + + + +.Appears In: +**** +- xref:{anchor_prefix}-github-com-codeready-toolchain-api-api-v1alpha1-hostconfig[$$HostConfig$$] +**** + +[cols="20a,50a,15a,15a", options="header"] +|=== +| Field | Description | Default | Validation +| *`enabled`* __boolean__ | Defines whether the PublicViewer support should be enabled or not + | false | +|=== + + [id="{anchor_prefix}-github-com-codeready-toolchain-api-api-v1alpha1-registrationserviceanalyticsconfig"] ==== RegistrationServiceAnalyticsConfig