Skip to content

Commit c7e9e45

Browse files
committed
Metada API: document timestamp.snapshot_meta
Document snapshot_meta as the API that should be used when interacting with timestamp meta information about snapshot. Also, document that "meta" is an internal detail mimicking the spec file format. Signed-off-by: Martin Vrachev <[email protected]>
1 parent 0390644 commit c7e9e45

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

tuf/api/metadata.py

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -849,8 +849,11 @@ class Timestamp(Signed):
849849
Timestamp contains information about the snapshot Metadata file.
850850
851851
Attributes:
852-
meta: A dictionary of filenames to MetaFiles. The only valid key value
853-
is the snapshot filename, as defined by the specification.
852+
snapshot_meta: MetaFile instance used as API for interacting with
853+
snapshot meta information.
854+
meta: Implementation detail mimicking the spec file format. A dictionary
855+
of filenames to MetaFiles. The only valid key value is the snapshot
856+
filename, as defined by the specification.
854857
"""
855858

856859
_signed_type = "timestamp"

0 commit comments

Comments
 (0)