From 93b1dfa29e21ae0caa42d44cc4a050aa29f45913 Mon Sep 17 00:00:00 2001 From: Lukas Puehringer Date: Mon, 29 Apr 2024 17:37:11 +0200 Subject: [PATCH] docs: Remove pre 1.0.0 disclaimers Once we release 1.0.0 we will strictly follow semver. If anything that is released as public API now changes in a backwards-incompatible way, we will bump the major version. This patch removes warnings about unexpected changes. Signed-off-by: Lukas Puehringer --- docs/signer.rst | 5 ++--- securesystemslib/dsse.py | 3 --- 2 files changed, 2 insertions(+), 6 deletions(-) diff --git a/docs/signer.rst b/docs/signer.rst index 854eac3f..e7806f4b 100644 --- a/docs/signer.rst +++ b/docs/signer.rst @@ -3,7 +3,7 @@ Signer API .. currentmodule:: securesystemslib.signer -The signer module provides a simple and unified cryptographic signing and signature verification API designed to work consistently regardless of the underlying signing technology. This is achieved with abstract interfaces backed by multiple implementations: +The signer module provides a simple and unified cryptographic signing and signature verification API designed to work consistently regardless of the underlying signing technology. This is achieved with abstract interfaces backed by multiple implementations: * ``Signer.sign`` * ``Key.verify_signature`` @@ -59,8 +59,7 @@ which may happen on different systems and at different points in time: 4. **Verify**, given a configured public key -.. warning:: - The API is experimental and may change without warning in versions ``<1.0.0``. +.. note:: See `'New Signer API' `_ blog post for background infos. diff --git a/securesystemslib/dsse.py b/securesystemslib/dsse.py index d80b1fa2..61e4975e 100644 --- a/securesystemslib/dsse.py +++ b/securesystemslib/dsse.py @@ -116,9 +116,6 @@ def sign(self, signer: Signer) -> Signature: def verify(self, keys: List[Key], threshold: int) -> Dict[str, Key]: """Verify the payload with the provided Keys. - NOTE: This API is experimental and might change (see - secure-systems-lab/dsse#55) - Arguments: keys: A list of public keys to verify the signatures. threshold: Number of signatures needed to pass the verification.