From 4e1ad9006f51049db60876dfe2e28065d441acf6 Mon Sep 17 00:00:00 2001 From: Guillaume Mulocher Date: Wed, 22 Nov 2023 16:53:27 +0100 Subject: [PATCH] doc: Remove BGP deprecated doc (#477) Doc: Remove BGP deprecated doc --- docs/advanced_usages/custom-tests.md | 4 ---- docs/api/tests.routing.bgp.md | 34 ---------------------------- 2 files changed, 38 deletions(-) diff --git a/docs/advanced_usages/custom-tests.md b/docs/advanced_usages/custom-tests.md index 46ac9b913..61fd1b495 100644 --- a/docs/advanced_usages/custom-tests.md +++ b/docs/advanced_usages/custom-tests.md @@ -283,10 +283,6 @@ In addition to the required `AntaTest.anta_tests` decorator, ANTA offers a set o - `anta.decorators.deprecated_test`: Use this to log a message of WARNING severity when a test is deprecated. - `anta.decorators.skip_on_platforms`: Use this to skip tests for functionalities that are not supported on specific platforms. -- `anta.decorators.check_bgp_family_enable`: Use this to skip tests when a particular BGP address family is not configured on the device. - -!!! warning - The `check_bgp_family_enable` decorator is deprecated and will eventually be removed in a future major release of ANTA. For more details, please refer to the [BGP tests section](../api/tests.routing.bgp.md). ```python from anta.decorators import skip_on_platforms diff --git a/docs/api/tests.routing.bgp.md b/docs/api/tests.routing.bgp.md index af2a2cfdd..68085aff0 100644 --- a/docs/api/tests.routing.bgp.md +++ b/docs/api/tests.routing.bgp.md @@ -6,40 +6,6 @@ # ANTA catalog for BGP tests -!!! warning "Deprecation Notice" - As part of our ongoing effort to improve the ANTA catalog and align it with best practices, we are announcing the deprecation of certain BGP tests along with a specific decorator. These will be removed in a future major release of ANTA. - -_What is being deprecated?_ - -- __Tests__: The following BGP tests in the ANTA catalog are marked for deprecation. - -```yaml -anta.tests.routing: - bgp: - - VerifyBGPIPv4UnicastState: - - VerifyBGPIPv4UnicastCount: - - VerifyBGPIPv6UnicastState: - - VerifyBGPEVPNState: - - VerifyBGPEVPNCount: - - VerifyBGPRTCState: - - VerifyBGPRTCCount: -``` - -- __Decorator__: The `check_bgp_family_enable` decorator is also being deprecated as it is no longer needed with the new refactored BGP tests. - -_What should you do?_ - -We strongly recommend transitioning to the new set of BGP tests that have been introduced to replace the deprecated ones. Please refer to each test documentation on this page below. - -```yaml -anta.tests.routing: - bgp: - - VerifyBGPPeerCount: - - VerifyBGPPeersHealth: - - VerifyBGPSpecificPeers: -``` -___ - ::: anta.tests.routing.bgp options: show_root_heading: false