From bcfba51897d83035a83b9b8c2ef4b5d9049a0b32 Mon Sep 17 00:00:00 2001 From: Don Naro Date: Mon, 27 Jul 2026 15:36:12 +0100 Subject: [PATCH 1/2] docs: use true false for all booleans in docs --- plugins/modules/k8s.py | 4 ++-- plugins/modules/openshift_adm_groups_sync.py | 2 +- plugins/modules/openshift_adm_prune_auth.py | 2 +- plugins/modules/openshift_adm_prune_builds.py | 2 +- plugins/modules/openshift_adm_prune_deployments.py | 2 +- plugins/modules/openshift_adm_prune_images.py | 12 ++++++------ plugins/modules/openshift_build.py | 4 ++-- plugins/modules/openshift_import_image.py | 8 ++++---- plugins/modules/openshift_registry_info.py | 2 +- 9 files changed, 19 insertions(+), 19 deletions(-) diff --git a/plugins/modules/k8s.py b/plugins/modules/k8s.py index e0770bc8..6591e46a 100644 --- a/plugins/modules/k8s.py +++ b/plugins/modules/k8s.py @@ -83,7 +83,7 @@ type: str strict: description: whether to fail when passing unexpected properties - default: True + default: true type: bool type: dict append_hash: @@ -134,7 +134,7 @@ - Whether to continue on creation/deletion errors when multiple resources are defined. - This has no effect on the validation step which is controlled by the C(validate.fail_on_error) parameter. type: bool - default: False + default: false version_added: 2.0.0 requirements: diff --git a/plugins/modules/openshift_adm_groups_sync.py b/plugins/modules/openshift_adm_groups_sync.py index 3f5f14be..388f69f6 100644 --- a/plugins/modules/openshift_adm_groups_sync.py +++ b/plugins/modules/openshift_adm_groups_sync.py @@ -51,7 +51,7 @@ aliases: - config - src - required: True + required: true deny_groups: description: - Denied groups, could be openshift group name or LDAP group dn value. diff --git a/plugins/modules/openshift_adm_prune_auth.py b/plugins/modules/openshift_adm_prune_auth.py index fe0aec2c..5cf919b5 100644 --- a/plugins/modules/openshift_adm_prune_auth.py +++ b/plugins/modules/openshift_adm_prune_auth.py @@ -37,7 +37,7 @@ - users - groups type: str - required: True + required: true name: description: - Use to specify an object name to remove. diff --git a/plugins/modules/openshift_adm_prune_builds.py b/plugins/modules/openshift_adm_prune_builds.py index ffc86f16..5f782506 100644 --- a/plugins/modules/openshift_adm_prune_builds.py +++ b/plugins/modules/openshift_adm_prune_builds.py @@ -41,7 +41,7 @@ - If C(true), prune all builds whose associated BuildConfig no longer exists and whose status is complete, failed, error, or cancelled. type: bool - default: False + default: false requirements: - python >= 3.6 diff --git a/plugins/modules/openshift_adm_prune_deployments.py b/plugins/modules/openshift_adm_prune_deployments.py index 963e3c94..6db8e6b7 100644 --- a/plugins/modules/openshift_adm_prune_deployments.py +++ b/plugins/modules/openshift_adm_prune_deployments.py @@ -41,7 +41,7 @@ - If C(true), prune all deployments where the associated DeploymentConfig no longer exists, the status is complete or failed, and the replica size is C(0). type: bool - default: False + default: false requirements: - python >= 3.6 diff --git a/plugins/modules/openshift_adm_prune_images.py b/plugins/modules/openshift_adm_prune_images.py index 41bd5c4f..172f052e 100644 --- a/plugins/modules/openshift_adm_prune_images.py +++ b/plugins/modules/openshift_adm_prune_images.py @@ -40,7 +40,7 @@ - Include images that were imported from external registries as candidates for pruning. - If pruned, all the mirrored objects associated with them will also be removed from the integrated registry. type: bool - default: True + default: true keep_younger_than: description: - Specify the minimum age (in minutes) of an image and its referrers for it to be considered a candidate for pruning. @@ -50,7 +50,7 @@ - Specify if images which are exceeding LimitRanges specified in the same namespace, should be considered for pruning. type: bool - default: False + default: false registry_url: description: - The address to use when contacting the registry, instead of using the default value. @@ -70,17 +70,17 @@ type: bool prune_registry: description: - - If set to I(False), the prune operation will clean up image API objects, but + - If set to I(false), the prune operation will clean up image API objects, but none of the associated content in the registry is removed. type: bool - default: True + default: true ignore_invalid_refs: description: - - If set to I(True), the pruning process will ignore all errors while parsing image references. + - If set to I(true), the pruning process will ignore all errors while parsing image references. - This means that the pruning process will ignore the intended connection between the object and the referenced image. - As a result an image may be incorrectly deleted as unused. type: bool - default: False + default: false requirements: - python >= 3.6 - kubernetes >= 12.0.0 diff --git a/plugins/modules/openshift_build.py b/plugins/modules/openshift_build.py index b397e237..b7c9c2ed 100644 --- a/plugins/modules/openshift_build.py +++ b/plugins/modules/openshift_build.py @@ -55,7 +55,7 @@ description: - Specify the namespace for the build or the build config. type: str - required: True + required: true build_args: description: - Specify a list of key-value pair to pass to Docker during the build. @@ -106,7 +106,7 @@ - When C(state=started), specify whether to wait for a build to complete and exit with a non-zero return code if the build fails. - When I(state=cancelled), specify whether to wait for a build phase to be Cancelled. - default: False + default: false type: bool wait_sleep: description: diff --git a/plugins/modules/openshift_import_image.py b/plugins/modules/openshift_import_image.py index e5f371b6..8e817e7b 100644 --- a/plugins/modules/openshift_import_image.py +++ b/plugins/modules/openshift_import_image.py @@ -36,18 +36,18 @@ description: - Use to specify namespace for image stream to create/update. type: str - required: True + required: true name: description: - Image stream to import tag into. - This can be provided as a list of images streams or a single value. type: raw - required: True + required: true all: description: - If set to I(true), import all tags from the provided source on creation or if C(source) is specified. type: bool - default: False + default: false validate_registry_certs: description: - If set to I(true), allow importing from registries that have invalid HTTPS certificates. @@ -65,7 +65,7 @@ description: - Set each imported Docker image to be periodically imported from a remote repository. type: bool - default: False + default: false source: description: - A Docker image repository to import images from. diff --git a/plugins/modules/openshift_registry_info.py b/plugins/modules/openshift_registry_info.py index 2693d253..7d439583 100644 --- a/plugins/modules/openshift_registry_info.py +++ b/plugins/modules/openshift_registry_info.py @@ -35,7 +35,7 @@ description: - Attempt to contact the integrated registry using local client. type: bool - default: False + default: false requirements: - python >= 3.6 From b022a7c46383bb071fedfa3cb0e97689a567a2a8 Mon Sep 17 00:00:00 2001 From: Don Naro Date: Mon, 27 Jul 2026 15:39:50 +0100 Subject: [PATCH 2/2] docs: add changelog fragment --- changelogs/fragments/187-lowercase-booleans.yml | 2 ++ 1 file changed, 2 insertions(+) create mode 100644 changelogs/fragments/187-lowercase-booleans.yml diff --git a/changelogs/fragments/187-lowercase-booleans.yml b/changelogs/fragments/187-lowercase-booleans.yml new file mode 100644 index 00000000..29eb4b0f --- /dev/null +++ b/changelogs/fragments/187-lowercase-booleans.yml @@ -0,0 +1,2 @@ +trivial: + - Use lowercase true/false for boolean values in module documentation (https://github.com/openshift/community.okd/issues/187).