From c58b5f91fdd990a6d17a5a2c9981f8b5218bd1a3 Mon Sep 17 00:00:00 2001 From: vitthalmagadum Date: Mon, 25 Nov 2024 06:10:13 -0500 Subject: [PATCH] Updated documentation --- anta/input_models/security.py | 6 +++--- docs/api/tests.security.md | 4 +++- 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/anta/input_models/security.py b/anta/input_models/security.py index b58b7e739..f8b59545c 100644 --- a/anta/input_models/security.py +++ b/anta/input_models/security.py @@ -53,15 +53,15 @@ def __str__(self) -> str: class IPSecPeers(IPSecPeer): # pragma: no cover - """Alias for the IPSecPeer model to maintain backward compatibility. + """Alias for the IPSecPeers model to maintain backward compatibility. - When initialized, it will emit a deprecation warning and call the IPSecPeers model. + When initialized, it will emit a deprecation warning and call the IPSecPeer model. TODO: Remove this class in ANTA v2.0.0. """ def __init__(self, **data: Any) -> None: # noqa: ANN401 - """Initialize the BgpAfi class, emitting a deprecation warning.""" + """Initialize the IPSecPeer class, emitting a deprecation warning.""" warn( message="IPSecPeers model is deprecated and will be removed in ANTA v2.0.0. Use the IPSecPeer model instead.", category=DeprecationWarning, diff --git a/docs/api/tests.security.md b/docs/api/tests.security.md index b482b19cd..599783236 100644 --- a/docs/api/tests.security.md +++ b/docs/api/tests.security.md @@ -33,4 +33,6 @@ anta_title: ANTA catalog for security tests merge_init_into_class: false anta_hide_test_module_description: true show_labels: true - filters: ["!^__str__"] + filters: + - "!^__init__" + - "!^__str__"