aboutsummaryrefslogtreecommitdiffstats
path: root/docs/sections/offeredapis.rst
blob: 7e59f76407a90e714d6b0fee8fe07831b229e07c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
.. Copyright (C) 2022 Nordix Foundation

.. _api_docs:

Offered APIs
============

The api javadocs for interfaces provided by the sdc distribution client can be compiled by building the project.

See :ref:`build steps<Build Steps>` for more information.

The javadocs can be then found under the ``sdc-distribution-client/target/apidocs`` folder.

The main interface that must be implemented by clients is the IConfiguration interface.

See the :ref:`configuration section<config>` configuration section for more details.