Skip to content

Commit

Permalink
chore: clarify docstring for VSA fields with special in-toto types
Browse files Browse the repository at this point in the history
Signed-off-by: Nathan Nguyen <nathan.nguyen@oracle.com>
  • Loading branch information
nathanwn committed Jan 10, 2024
1 parent 60ca8cf commit 6870a3a
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions src/macaron/vsa/vsa.py
Original file line number Diff line number Diff line change
Expand Up @@ -78,19 +78,19 @@ class VsaPredicate(TypedDict):
verifier: Verifier

#: The timestamp when the verification occurred.
#: The field has the type
#: The field is a
#: `Timestamp <https://github.com/in-toto/attestation/blob/main/spec/v1/field_types.md#Timestamp>`_.
timeVerified: str # noqa: N815

#: URI that identifies the resource associated with the software component being verified.
#: This field has the type
#: This field is a
#: `ResourceURI <https://github.com/in-toto/attestation/blob/main/spec/v1/field_types.md#ResourceURI>`_.
#: Currently, this has the same value as the subject of the VSA, i.e. the PURL of
#: the software component being verified against.
resourceUri: str # noqa: N815

#: The policy that the subject software component was verified against.
#: This field has the type
#: This field is a
#: `ResourceDescriptor <https://github.com/in-toto/attestation/blob/main/spec/v1/resource_descriptor.md>`_.
policy: dict[str, Any]

Expand Down

0 comments on commit 6870a3a

Please sign in to comment.