From fb69ec304c1ee4a73dbf45caeeed9b2a7347ad99 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bj=C3=B6rn=20Ricks?= Date: Thu, 11 Aug 2022 12:06:53 +0200 Subject: [PATCH] Fix: Add missing API docs for GMP 22.4 class (#804) --- docs/api/gmpv214.rst | 19 +++++++++ docs/api/gmpv224.rst | 92 ++++++++++++++++++++++++++++++++++++++++++ docs/api/protocols.rst | 1 + 3 files changed, 112 insertions(+) create mode 100644 docs/api/gmpv224.rst diff --git a/docs/api/gmpv214.rst b/docs/api/gmpv214.rst index 8effadf71..f209aba7c 100644 --- a/docs/api/gmpv214.rst +++ b/docs/api/gmpv214.rst @@ -11,78 +11,97 @@ Enums .. autoclass:: AlertCondition :members: :undoc-members: + :noindex: .. autoclass:: AlertEvent :members: :undoc-members: + :noindex: .. autoclass:: AlertMethod :members: :undoc-members: + :noindex: .. autoclass:: AliveTest :members: :undoc-members: + :noindex: .. autoclass:: CredentialFormat :members: :undoc-members: + :noindex: .. autoclass:: CredentialType :members: :undoc-members: + :noindex: .. autoclass:: EntityType :members: :undoc-members: + :noindex: .. autoclass:: FeedType :members: :undoc-members: + :noindex: .. autoclass:: FilterType :members: :undoc-members: + :noindex: .. autoclass:: HostsOrdering :members: :undoc-members: + :noindex: .. autoclass:: HelpFormat :members: :undoc-members: + :noindex: .. autoclass:: InfoType :members: :undoc-members: + :noindex: .. autoclass:: PermissionSubjectType :members: :undoc-members: + :noindex: .. autoclass:: ScannerType :members: :undoc-members: + :noindex: .. autoclass:: PortRangeType :members: :undoc-members: + :noindex: .. autoclass:: SeverityLevel :members: :undoc-members: + :noindex: .. autoclass:: SnmpAuthAlgorithm :members: :undoc-members: + :noindex: .. autoclass:: SnmpPrivacyAlgorithm :members: :undoc-members: + :noindex: .. autoclass:: TicketStatus :members: :undoc-members: + :noindex: Protocol -------- diff --git a/docs/api/gmpv224.rst b/docs/api/gmpv224.rst new file mode 100644 index 000000000..117cccce5 --- /dev/null +++ b/docs/api/gmpv224.rst @@ -0,0 +1,92 @@ +.. _gmpv224: + +GMP v22.4 +^^^^^^^^^ + +.. automodule:: gvm.protocols.gmpv224 + +Enums +----- + +.. autoclass:: AlertCondition + :members: + :undoc-members: + +.. autoclass:: AlertEvent + :members: + :undoc-members: + +.. autoclass:: AlertMethod + :members: + :undoc-members: + +.. autoclass:: AliveTest + :members: + :undoc-members: + +.. autoclass:: CredentialFormat + :members: + :undoc-members: + +.. autoclass:: CredentialType + :members: + :undoc-members: + +.. autoclass:: EntityType + :members: + :undoc-members: + +.. autoclass:: FeedType + :members: + :undoc-members: + +.. autoclass:: FilterType + :members: + :undoc-members: + +.. autoclass:: HostsOrdering + :members: + :undoc-members: + +.. autoclass:: HelpFormat + :members: + :undoc-members: + +.. autoclass:: InfoType + :members: + :undoc-members: + +.. autoclass:: PermissionSubjectType + :members: + :undoc-members: + +.. autoclass:: ScannerType + :members: + :undoc-members: + +.. autoclass:: PortRangeType + :members: + :undoc-members: + +.. autoclass:: SeverityLevel + :members: + :undoc-members: + +.. autoclass:: SnmpAuthAlgorithm + :members: + :undoc-members: + +.. autoclass:: SnmpPrivacyAlgorithm + :members: + :undoc-members: + +.. autoclass:: TicketStatus + :members: + :undoc-members: + +Protocol +-------- + +.. autoclass:: Gmp + :members: + :inherited-members: diff --git a/docs/api/protocols.rst b/docs/api/protocols.rst index 40f616ae7..848f3fbac 100644 --- a/docs/api/protocols.rst +++ b/docs/api/protocols.rst @@ -10,6 +10,7 @@ Protocols gmpv208 gmpv214 + gmpv224 ospv1 Dynamic