Revize a6727aa9

Re #8472 - Added missing docstrings to KeyService and CertificateService classes

src/services/key_service.py

@@ -9 +9 @@
         self.cryptography_service = cryptography_service
         self.private_key_repository = private_key_repository
 
-    def create_new_key(self, passphrase=""):
+    def create_new_key(self, passphrase="") -> PrivateKey:
+        """
+        Creates a new private key using the given passphrase.
+        :param passphrase: Passphrase to be used when encrypting the PK
+        :return: An instance of the <PrivateKey> class representing the generated PK
+        """
         # generate a new private key
         private_key_pem = self.cryptography_service.create_private_key(passphrase)
 
@@ -25 +30 @@
         return private_key
 
     def get_key(self, unique_id):
+        """
+        Tries to fetch a PK using the given ID.
+        :param unique_id: ID of the PK to be found
+        :return:An instance of the required PK or `None`
+        """
         return self.private_key_repository.read(unique_id)
 
     def get_keys(self, unique_ids=None):
+        """
+        Tries to fetch all PKs in the repository. Exact PKs to be fetched can be specified using the `unique_ids`
+        parameter. If `unique_ids` parameter is not passed then all PKs in the repository are returned.
+        :param unique_ids: An array containing IDs of PKs to be fetched from the repository.
+        :return: A list of instances of the PrivateKey class representing the PKs found
+        """
         if unique_ids is None:
             return self.private_key_repository.read_all()
         else:
@@ -35 +51 @@
             return [self.private_key_repository.read(identifier) for identifier in unique_ids]
 
     def delete_key(self, unique_id):
+        """
+        Deletes a private key
+
+        :param unique_id: ID of specific certificate to be deleted
+        :return: `True` when the deletion was successful. `False` in other case
+        """
         return self.private_key_repository.delete(unique_id)