From 4ce9745d35109ec71b33cea3dcc31b0aeb9b1d73 Mon Sep 17 00:00:00 2001 From: Felix Fontein Date: Sun, 29 Dec 2024 16:17:03 +0100 Subject: [PATCH] Put appropriate module attributes into doc fragments. --- plugins/doc_fragments/module_certificate.py | 3 +++ plugins/doc_fragments/module_csr.py | 3 +++ plugins/doc_fragments/module_privatekey.py | 3 +++ plugins/doc_fragments/module_privatekey_convert.py | 3 +++ plugins/modules/openssl_csr.py | 2 -- plugins/modules/openssl_csr_pipe.py | 2 -- plugins/modules/openssl_privatekey.py | 2 -- plugins/modules/openssl_privatekey_convert.py | 2 -- plugins/modules/openssl_privatekey_pipe.py | 2 -- plugins/modules/x509_certificate.py | 2 -- plugins/modules/x509_certificate_pipe.py | 2 -- 11 files changed, 12 insertions(+), 14 deletions(-) diff --git a/plugins/doc_fragments/module_certificate.py b/plugins/doc_fragments/module_certificate.py index 2bde9a75..e9a18fd6 100644 --- a/plugins/doc_fragments/module_certificate.py +++ b/plugins/doc_fragments/module_certificate.py @@ -16,6 +16,9 @@ class ModuleDocFragment(object): description: - This module allows one to (re)generate OpenSSL certificates. - It uses the cryptography python library to interact with OpenSSL. +attributes: + diff_mode: + support: full requirements: - cryptography >= 1.6 (if using V(selfsigned) or V(ownca) provider) options: diff --git a/plugins/doc_fragments/module_csr.py b/plugins/doc_fragments/module_csr.py index e9b7e3cd..18a18cc8 100644 --- a/plugins/doc_fragments/module_csr.py +++ b/plugins/doc_fragments/module_csr.py @@ -15,6 +15,9 @@ class ModuleDocFragment(object): description: - This module allows one to (re)generate OpenSSL certificate signing requests. - This module supports the subjectAltName, keyUsage, extendedKeyUsage, basicConstraints and OCSP Must Staple extensions. +attributes: + diff_mode: + support: full requirements: - cryptography >= 1.3 options: diff --git a/plugins/doc_fragments/module_privatekey.py b/plugins/doc_fragments/module_privatekey.py index fe89787d..fad9b9b3 100644 --- a/plugins/doc_fragments/module_privatekey.py +++ b/plugins/doc_fragments/module_privatekey.py @@ -17,6 +17,9 @@ description: L(ECC,https://en.wikipedia.org/wiki/Elliptic-curve_cryptography) or L(EdDSA,https://en.wikipedia.org/wiki/EdDSA) private keys. - Keys are generated in PEM format. +attributes: + diff_mode: + support: full requirements: - cryptography >= 1.2.3 (older versions might work as well) options: diff --git a/plugins/doc_fragments/module_privatekey_convert.py b/plugins/doc_fragments/module_privatekey_convert.py index 63e7ce11..4db55f48 100644 --- a/plugins/doc_fragments/module_privatekey_convert.py +++ b/plugins/doc_fragments/module_privatekey_convert.py @@ -14,6 +14,9 @@ class ModuleDocFragment(object): DOCUMENTATION = r""" requirements: - cryptography >= 1.2.3 (older versions might work as well) +attributes: + diff_mode: + support: none options: src_path: description: diff --git a/plugins/modules/openssl_csr.py b/plugins/modules/openssl_csr.py index 87853df3..dcc1015e 100644 --- a/plugins/modules/openssl_csr.py +++ b/plugins/modules/openssl_csr.py @@ -27,8 +27,6 @@ extends_documentation_fragment: attributes: check_mode: support: full - diff_mode: - support: full safe_file_operations: support: full options: diff --git a/plugins/modules/openssl_csr_pipe.py b/plugins/modules/openssl_csr_pipe.py index 68295165..93ef55bd 100644 --- a/plugins/modules/openssl_csr_pipe.py +++ b/plugins/modules/openssl_csr_pipe.py @@ -31,8 +31,6 @@ attributes: in community.crypto 3.0.0. - From community.crypto 3.0.0 on, the module will ignore check mode and always behave as if check mode is not active. If you think this breaks your use-case of this module, please create an issue in the community.crypto repository. - diff_mode: - support: full options: content: description: diff --git a/plugins/modules/openssl_privatekey.py b/plugins/modules/openssl_privatekey.py index e7c8bde0..1feb5079 100644 --- a/plugins/modules/openssl_privatekey.py +++ b/plugins/modules/openssl_privatekey.py @@ -29,8 +29,6 @@ extends_documentation_fragment: attributes: check_mode: support: full - diff_mode: - support: full safe_file_operations: support: full options: diff --git a/plugins/modules/openssl_privatekey_convert.py b/plugins/modules/openssl_privatekey_convert.py index 5f383a02..d53d216f 100644 --- a/plugins/modules/openssl_privatekey_convert.py +++ b/plugins/modules/openssl_privatekey_convert.py @@ -26,8 +26,6 @@ extends_documentation_fragment: attributes: check_mode: support: full - diff_mode: - support: none safe_file_operations: support: full options: diff --git a/plugins/modules/openssl_privatekey_pipe.py b/plugins/modules/openssl_privatekey_pipe.py index 925515bc..5bdbaeff 100644 --- a/plugins/modules/openssl_privatekey_pipe.py +++ b/plugins/modules/openssl_privatekey_pipe.py @@ -41,8 +41,6 @@ attributes: in community.crypto 3.0.0. - From community.crypto 3.0.0 on, the module will ignore check mode and always behave as if check mode is not active. If you think this breaks your use-case of this module, please create an issue in the community.crypto repository. - diff_mode: - support: full options: content: description: diff --git a/plugins/modules/x509_certificate.py b/plugins/modules/x509_certificate.py index fc2a11c8..53e82030 100644 --- a/plugins/modules/x509_certificate.py +++ b/plugins/modules/x509_certificate.py @@ -38,8 +38,6 @@ extends_documentation_fragment: attributes: check_mode: support: full - diff_mode: - support: full safe_file_operations: support: full options: diff --git a/plugins/modules/x509_certificate_pipe.py b/plugins/modules/x509_certificate_pipe.py index a4caa0b1..e7c312cf 100644 --- a/plugins/modules/x509_certificate_pipe.py +++ b/plugins/modules/x509_certificate_pipe.py @@ -35,8 +35,6 @@ attributes: in community.crypto 3.0.0. - From community.crypto 3.0.0 on, the module will ignore check mode and always behave as if check mode is not active. If you think this breaks your use-case of this module, please create an issue in the community.crypto repository. - diff_mode: - support: full options: provider: description: