From 1b6ef48fd23f2c38833c9f7869d7c613949eabff Mon Sep 17 00:00:00 2001
From: Bernd Zeimetz <bernd@bzed.de>
Date: Mon, 27 Jan 2025 11:31:42 +0100
Subject: [PATCH] Add type documentation

---
 types/algorithm.pp     | 1 +
 types/challengetype.pp | 1 +
 types/crt.pp           | 1 +
 types/csr.pp           | 1 +
 types/email.pp         | 1 +
 types/gitsshurl.pp     | 1 +
 types/hook.pp          | 1 +
 7 files changed, 7 insertions(+)

diff --git a/types/algorithm.pp b/types/algorithm.pp
index dbef489..3a540c3 100644
--- a/types/algorithm.pp
+++ b/types/algorithm.pp
@@ -1 +1,2 @@
+# Algorithms supported by dehydrated/letsencrypt
 type Dehydrated::Algorithm = Pattern[/^(rsa|prime256v1|secp384r1)$/]
diff --git a/types/challengetype.pp b/types/challengetype.pp
index 61d05c3..d8700b8 100644
--- a/types/challengetype.pp
+++ b/types/challengetype.pp
@@ -1 +1,2 @@
+# Valid challenge types for letsencrypt
 type Dehydrated::Challengetype = Pattern[/^(http-01|dns-01|tls-alpn-01)$/]
diff --git a/types/crt.pp b/types/crt.pp
index 0a4d5b8..5879b09 100644
--- a/types/crt.pp
+++ b/types/crt.pp
@@ -1 +1,2 @@
+# PEM Certificate
 type Dehydrated::CRT = Pattern[/(?m:.*-+BEGIN CERTIFICATE-+.*-+END CERTIFICATE-+.*)/]
diff --git a/types/csr.pp b/types/csr.pp
index 443ad89..39425a7 100644
--- a/types/csr.pp
+++ b/types/csr.pp
@@ -1 +1,2 @@
+# PEM CSR
 type Dehydrated::CSR = Pattern[/(?m:.*-+BEGIN CERTIFICATE REQUEST-+.*-+END CERTIFICATE REQUEST-+.*)/]
diff --git a/types/email.pp b/types/email.pp
index 5130263..1346329 100644
--- a/types/email.pp
+++ b/types/email.pp
@@ -1 +1,2 @@
+# match an email address
 type Dehydrated::Email = Pattern[/^(?i:[A-Z0-9_%+"-]+[A-Z0-9._%+"-]+@[A-Z0-9.-]+\.[A-Z]{2,})$/]
diff --git a/types/gitsshurl.pp b/types/gitsshurl.pp
index 6901369..e0c11a5 100644
--- a/types/gitsshurl.pp
+++ b/types/gitsshurl.pp
@@ -1 +1,2 @@
+# Match ssh URLs for git
 type Dehydrated::GitSSHUrl = Pattern[/(?i:^(ssh:\/\/([^\/@]+@)?[^\/]+\/.*|([^@:]+@)?[^:]+:.*))/]
diff --git a/types/hook.pp b/types/hook.pp
index 1a2baca..3e4baae 100644
--- a/types/hook.pp
+++ b/types/hook.pp
@@ -1 +1,2 @@
+# Match a filename for a hook, don not follow paths.
 type Dehydrated::Hook = Pattern[/^[^\\\/]+$/]