updated documentation apis

aristanetworks · Jan 8, 2025 · bb12cc2 · bb12cc2
1 parent 581acc2
commit bb12cc2
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 1 deletion.
diff --git a/anta/tests/snmp.py b/anta/tests/snmp.py
@@ -350,7 +350,7 @@ def test(self) -> None:
 class VerifySnmpUser(AntaTest):
     """Verifies the SNMP user configurations for specified version(s).
 
-    This test performs the following checks for each specified address family:
+    This test performs the following checks for each specified user:
 
       1. Verifies that the valid user name and group name.
       2. Ensures that the SNMP v3 security model, the user authentication and privacy settings aligning with version-specific requirements.

diff --git a/docs/api/tests.snmp.md b/docs/api/tests.snmp.md
@@ -7,7 +7,10 @@ anta_title: ANTA catalog for SNMP tests
   ~ that can be found in the LICENSE file.
   -->
 
+# Tests
+
 ::: anta.tests.snmp
+
     options:
       show_root_heading: false
       show_root_toc_entry: false
@@ -18,3 +21,16 @@ anta_title: ANTA catalog for SNMP tests
       filters:
         - "!test"
         - "!render"
+
+# Input models
+
+::: anta.input_models.snmp
+
+    options:
+      show_root_heading: false
+      show_root_toc_entry: false
+      show_bases: false
+      merge_init_into_class: false
+      anta_hide_test_module_description: true
+      show_labels: true
+      filters: ["!^__str__"]