Skip to content

Commit 0604f70

Browse files
committed
NEW API: Fix documentation indentation
From the reST/sphinx docs: https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#literal-blocks I added new lines and an identation where it was missed. Signed-off-by: Martin Vrachev <mvrachev@vmware.com>
1 parent 71c4992 commit 0604f70

File tree

1 file changed

+37
-34
lines changed

1 file changed

+37
-34
lines changed

tuf/api/metadata.py

Lines changed: 37 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -511,16 +511,19 @@ class Root(Signed):
511511
supports consistent snapshots.
512512
keys: A dictionary that contains a public key store used to verify
513513
top level roles metadata signatures::
514-
{
515-
'<KEYID>': <Key instance>,
516-
...
517-
},
514+
515+
{
516+
'<KEYID>': <Key instance>,
517+
...
518+
},
519+
518520
roles: A dictionary that contains a list of signing keyids and
519521
a signature threshold for each top level role::
520-
{
521-
'<ROLE>': <Role istance>,
522-
...
523-
}
522+
523+
{
524+
'<ROLE>': <Role istance>,
525+
...
526+
}
524527
525528
"""
526529

@@ -760,34 +763,34 @@ class Targets(Signed):
760763
roles and public key store used to verify their metadata
761764
signatures::
762765
763-
{
764-
'keys' : {
765-
'<KEYID>': {
766-
'keytype': '<KEY TYPE>',
767-
'scheme': '<KEY SCHEME>',
768-
'keyid_hash_algorithms': [
769-
'<HASH ALGO 1>',
770-
'<HASH ALGO 2>'
771-
...
772-
],
773-
'keyval': {
774-
'public': '<PUBLIC KEY HEX REPRESENTATION>'
775-
}
766+
{
767+
'keys' : {
768+
'<KEYID>': {
769+
'keytype': '<KEY TYPE>',
770+
'scheme': '<KEY SCHEME>',
771+
'keyid_hash_algorithms': [
772+
'<HASH ALGO 1>',
773+
'<HASH ALGO 2>'
774+
...
775+
],
776+
'keyval': {
777+
'public': '<PUBLIC KEY HEX REPRESENTATION>'
778+
}
779+
},
780+
...
776781
},
782+
'roles': [
783+
{
784+
'name': '<ROLENAME>',
785+
'keyids': ['<SIGNING KEY KEYID>', ...],
786+
'threshold': <SIGNATURE THRESHOLD>,
787+
'terminating': <TERMINATING BOOLEAN>,
788+
'path_hash_prefixes': ['<HEX DIGEST>', ... ], // or
789+
'paths' : ['PATHPATTERN', ... ],
790+
},
777791
...
778-
},
779-
'roles': [
780-
{
781-
'name': '<ROLENAME>',
782-
'keyids': ['<SIGNING KEY KEYID>', ...],
783-
'threshold': <SIGNATURE THRESHOLD>,
784-
'terminating': <TERMINATING BOOLEAN>,
785-
'path_hash_prefixes': ['<HEX DIGEST>', ... ], // or
786-
'paths' : ['PATHPATTERN', ... ],
787-
},
788-
...
789-
]
790-
}
792+
]
793+
}
791794
792795
"""
793796

0 commit comments

Comments
 (0)