Skip to content

Commit 95deafb

Browse files
committed
Added API documentation
1 parent 24670a9 commit 95deafb

File tree

5 files changed

+1663
-2071
lines changed

5 files changed

+1663
-2071
lines changed

docs/api/index.md

+4-13
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,6 @@
1-
.. _api-index:
1+
# NSClient++ API
22

3-
# API #
3+
This is a placeholder for where the real API docs will be.
44

5-
TODO
6-
7-
Contents:
8-
9-
<dl>
10-
<dt>.. toctree : : </dt>
11-
<dd>
12-
<p>:maxdepth: 1</p>
13-
<p>plugin.rst</p>
14-
</dd>
15-
</dl>
5+
Currently we have documentation for the [protocol buffer API used by plugins](plugin.md).
6+
This is very similar to the current REST API as well as it uses an json version of the same.

docs/api/nscpipc.md

-186
This file was deleted.

0 commit comments

Comments
 (0)