[pmg-devel] [PATCH pmg-api v3 1/2] api: document that fingerprints are a SHA 256

[Maximiliano Sandoval]

We use the description from the standard option 'fingerprint-sha256'.
The option itself cannot be used as the regex allows lowercase
characters which don't work here.

Signed-off-by: Maximiliano Sandoval <m.sandoval at proxmox.com>
---

Differences from v2:
 - Use the same docstring as in pve-common
 - Add regex pattern into the same patch

 src/PMG/API2/Cluster.pm  | 2 +-
 src/PMG/CLI/pmgcm.pm     | 2 +-
 src/PMG/ClusterConfig.pm | 2 +-
 3 files changed, 3 insertions(+), 3 deletions(-)

diff --git a/src/PMG/API2/Cluster.pm b/src/PMG/API2/Cluster.pm
index 84dafabb..6d776548 100644
--- a/src/PMG/API2/Cluster.pm
+++ b/src/PMG/API2/Cluster.pm
@@ -409,7 +409,7 @@ __PACKAGE__->register_method({
 		type => 'string', format => 'ip',
 	    },
 	    fingerprint => {
-		description => "SSL certificate fingerprint.",
+		description => "Certificate SHA 256 fingerprint.",
 		type => 'string',
 		pattern => '^(:?[A-Z0-9][A-Z0-9]:){31}[A-Z0-9][A-Z0-9]$',
 	    },
diff --git a/src/PMG/CLI/pmgcm.pm b/src/PMG/CLI/pmgcm.pm
index ecf9cc76..b4601de4 100644
--- a/src/PMG/CLI/pmgcm.pm
+++ b/src/PMG/CLI/pmgcm.pm
@@ -167,7 +167,7 @@ __PACKAGE__->register_method({
 		type => 'string', format => 'ip',
 	    },
 	    fingerprint => {
-		description => "SSL certificate fingerprint.",
+		description => "Certificate SHA 256 fingerprint.",
 		type => 'string',
 		pattern => '^(:?[A-Z0-9][A-Z0-9]:){31}[A-Z0-9][A-Z0-9]$',
 		optional => 1,
diff --git a/src/PMG/ClusterConfig.pm b/src/PMG/ClusterConfig.pm
index c52508dc..ad4acd05 100644
--- a/src/PMG/ClusterConfig.pm
+++ b/src/PMG/ClusterConfig.pm
@@ -73,7 +73,7 @@ sub properties {
 	    pattern => valid_ssh_pubkey_regex(),
 	},
 	fingerprint => {
-	    description => "SSL certificate fingerprint.",
+	    description => "Certificate SHA 256 fingerprint.",
 	    type => 'string',
 	    pattern => '^(:?[A-Z0-9][A-Z0-9]:){31}[A-Z0-9][A-Z0-9]$',
 	},
-- 
2.39.5