Add documentation for default_keyid

secure-systems-lab · Apr 3, 2020 · ea303af · ea303af
1 parent e68fe02
commit ea303af
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/securesystemslib/keys.py b/securesystemslib/keys.py
@@ -517,6 +517,10 @@ def format_metadata_to_key(key_metadata, default_keyid=None):
        'scheme': scheme,
        'keyval': {'public': '...',
                   'private': '...'}}
+    default_keyid:
+      A default keyid associated with the key metadata. If this is not
+      provided, the keyid will be calculated by _get_keyid using the default
+      hash algorithm. If provided, the default keyid can be any string.
 
   <Exceptions>
     securesystemslib.exceptions.FormatError, if 'key_metadata' does not conform