From 53cb7c9c1e340e3aabf766b8fc1611a0c57af7ec Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?J=C3=B6rn-Michael=20Miehe?=
 <40151420+ldericher@users.noreply.github.com>
Date: Wed, 30 Mar 2022 10:43:02 +0000
Subject: [PATCH] doc strings

---
 api/kiwi_vpn_api/config.py | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/api/kiwi_vpn_api/config.py b/api/kiwi_vpn_api/config.py
index bfa4fb5..085fa44 100644
--- a/api/kiwi_vpn_api/config.py
+++ b/api/kiwi_vpn_api/config.py
@@ -170,11 +170,19 @@ class JWTConfig(BaseModel):
 
 
 class LockableString(BaseModel):
+    """
+    A string that can be (logically) locked with an attached bool
+    """
+
     value: str
     locked: bool
 
 
 class LockableCountry(LockableString):
+    """
+    Like `LockableString`, but with a `value` constrained two characters
+    """
+
     value: constr(max_length=2)
 
 
@@ -191,6 +199,10 @@ class DNParts(BaseModel):
 
 
 class CertificateAlgo(Enum):
+    """
+    Supported certificate signing algorithms
+    """
+
     rsa2048 = "rsa2048"
     rsa4096 = "rsa4096"
     secp256r1 = "secp256r1"