Skip to content

Commit 7af2fc1

Browse files
ozgenbjoernricks
authored andcommitted
Doc: update and fix openvasd API documentation pages
1 parent 3a7eab7 commit 7af2fc1

File tree

6 files changed

+50
-3
lines changed

6 files changed

+50
-3
lines changed

docs/api/health.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
Health API
2+
==========
3+
4+
.. automodule:: gvm.protocols.http.openvasd.health
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

docs/api/metadata.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
Metadata API
2+
============
3+
4+
.. automodule:: gvm.protocols.http.openvasd.metadata
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

docs/api/notus.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
Notus API
2+
=========
3+
4+
.. automodule:: gvm.protocols.http.openvasd.notus
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

docs/api/openvasdv1.rst

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,19 @@
33
openvasd v1
44
^^^^^^^^^^^
55

6-
.. automodule:: gvm.protocols.http.openvasd.openvasd1
6+
.. automodule:: gvm.protocols.http.openvasd.openvasdv1
7+
:members:
8+
:undoc-members:
9+
:show-inheritance:
710

8-
.. autoclass:: OpenvasdHttpApiV1
9-
:members:
11+
Submodules
12+
----------
13+
14+
.. toctree::
15+
:maxdepth: 1
16+
17+
health
18+
metadata
19+
notus
20+
scans
21+
vts

docs/api/scans.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
Scans API
2+
=========
3+
4+
.. automodule:: gvm.protocols.http.openvasd.scans
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

docs/api/vts.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
Vts API
2+
=======
3+
4+
.. automodule:: gvm.protocols.http.openvasd.vts
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

0 commit comments

Comments
 (0)