Skip to content

Commit 315e11e

Browse files
committed
Improve docs for openvasd http v1 API
Use markdown for all sources.
1 parent 243ddff commit 315e11e

File tree

17 files changed

+72
-76
lines changed

17 files changed

+72
-76
lines changed

docs/api/health.rst

Lines changed: 0 additions & 7 deletions
This file was deleted.

docs/api/http.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
(http)=
2+
3+
# HTTP APIs
4+
5+
```{eval-rst}
6+
.. automodule:: gvm.protocols.http
7+
```
8+
9+
The following modules are provided:
10+
11+
```{eval-rst}
12+
.. toctree::
13+
:maxdepth: 1
14+
15+
openvasdv1
16+
```

docs/api/http.rst

Lines changed: 0 additions & 11 deletions
This file was deleted.

docs/api/metadata.rst

Lines changed: 0 additions & 7 deletions
This file was deleted.

docs/api/notus.rst

Lines changed: 0 additions & 7 deletions
This file was deleted.

docs/api/openvasdv1.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
(openvasdv1)=
2+
3+
# openvasd v1
4+
5+
```{eval-rst}
6+
.. automodule:: gvm.protocols.http.openvasd
7+
:members:
8+
```
9+
10+
```{toctree}
11+
:hidden:
12+
13+
openvasdv1/health
14+
openvasdv1/metadata
15+
openvasdv1/notus
16+
openvasdv1/scans
17+
openvasdv1/vts
18+
```

docs/api/openvasdv1.rst

Lines changed: 0 additions & 21 deletions
This file was deleted.

docs/api/openvasdv1/health.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Health API
2+
3+
```{eval-rst}
4+
.. automodule:: gvm.protocols.http.openvasd._health
5+
:members:
6+
```

docs/api/openvasdv1/metadata.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Metadata API
2+
3+
```{eval-rst}
4+
.. automodule:: gvm.protocols.http.openvasd._metadata
5+
:members:
6+
```

docs/api/openvasdv1/notus.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Notus API
2+
3+
```{eval-rst}
4+
.. automodule:: gvm.protocols.http.openvasd._notus
5+
:members:
6+
```

docs/api/openvasdv1/scans.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Scans API
2+
3+
```{eval-rst}
4+
.. automodule:: gvm.protocols.http.openvasd._scans
5+
:members:
6+
```

docs/api/openvasdv1/vts.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# VTs API
2+
3+
```{eval-rst}
4+
.. automodule:: gvm.protocols.http.openvasd._vts
5+
:members:
6+
```

docs/api/protocols.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@
1111
1212
gmp
1313
ospv1
14+
http
1415
```
1516

1617
## Dynamic

docs/api/scans.rst

Lines changed: 0 additions & 7 deletions
This file was deleted.

docs/api/vts.rst

Lines changed: 0 additions & 7 deletions
This file was deleted.

gvm/protocols/http/__init__.py

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,5 @@
55
"""
66
Package for supported Greenbone HTTP APIs.
77
8-
Currently only `openvasd version 1`_ is supported.
9-
10-
.. _openvasd version 1:
11-
https://greenbone.github.io/scanner-api/#/
8+
Currently only `openvasd version 1 <https://greenbone.github.io/scanner-api/#/>`_ is supported.
129
"""

gvm/protocols/http/openvasd/__init__.py

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,14 @@
33
# SPDX-License-Identifier: GPL-3.0-or-later
44

55
"""
6-
Package for sending requests to openvasd and handling HTTP API responses.
7-
8-
Modules:
9-
- :class:`OpenvasdHttpApiV1` – Main class for communicating with OpenVASD API v1.
6+
High-level API interface for interacting with openvasd HTTP services via
7+
logical modules (health, metadata, scans, etc.).
108
119
Usage:
12-
from gvm.protocols.http.openvasd import OpenvasdHttpApiV1
10+
11+
.. code-block:: python
12+
13+
from gvm.protocols.http.openvasd import OpenvasdHttpAPIv1
1314
"""
1415

1516
from ._openvasd1 import OpenvasdHttpAPIv1

0 commit comments

Comments
 (0)