summaryrefslogtreecommitdiffstats
path: root/docs/sections/apis/SDK.rst
diff options
context:
space:
mode:
authorpwielebs <piotr.wielebski@nokia.com>2019-04-24 11:44:37 +0200
committerpwielebs <piotr.wielebski@nokia.com>2019-04-30 09:45:48 +0200
commit30355d90858eaccd6dedd09f6811d3d112e400a2 (patch)
treef5d678493c950ba1e9e8ec4d435671429b6c4cb7 /docs/sections/apis/SDK.rst
parent09dab76658142089c222c7ce200cfbbf378080a2 (diff)
Add initial documentation for DCAE SDK
Change-Id: Ic6b480fe058f87b74a716e2e5eee1b1d1ea9cd64 Issue-ID: DCAEGEN2-1447 Signed-off-by: pwielebs <piotr.wielebski@nokia.com>
Diffstat (limited to 'docs/sections/apis/SDK.rst')
-rw-r--r--docs/sections/apis/SDK.rst54
1 files changed, 54 insertions, 0 deletions
diff --git a/docs/sections/apis/SDK.rst b/docs/sections/apis/SDK.rst
new file mode 100644
index 00000000..d44dda59
--- /dev/null
+++ b/docs/sections/apis/SDK.rst
@@ -0,0 +1,54 @@
+========
+DCAE SDK
+========
+
+:Date: 2019-04-29
+
+.. contents::
+ :depth: 3
+..
+
+Overview
+========
+
+DCAE SDK contains utilities and clients which may be used for fetching configuration from CBS, consuming messages from DMaaP, interacting with A&AI, etc. SDK is written in Java.
+
+Introduction
+============
+
+ SDK Maven dependencies (modules).
+
+ .. code-block:: XML
+
+ <properties>
+ <sdk.version>1.1.4</sdk.version>
+ </properties>
+
+ <dependencies>
+ <dependency>
+ <groupId>org.onap.dcaegen2.services.sdk.rest.services</groupId>
+ <artifactId>cbs-client</artifactId>
+ <version>${sdk.version}</version>
+ </dependency>
+
+ <dependency>
+ <groupId>org.onap.dcaegen2.services.sdk.security.crypt</groupId>
+ <artifactId>crypt-password</artifactId>
+ <version>${sdk.version}</version>
+ </dependency>
+
+ <dependency>
+ <groupId>org.onap.dcaegen2.services.sdk</groupId>
+ <artifactId>hvvesclient-producer-api</artifactId>
+ <version>${sdk.version}</version>
+ </dependency>
+
+ <dependency>
+ <groupId>org.onap.dcaegen2.services.sdk</groupId>
+ <artifactId>hvvesclient-producer-impl</artifactId>
+ <version>${sdk.version}</version>
+ <scope>runtime</scope>
+ </dependency>
+ <!-- more to go -->
+
+ </dependencies> \ No newline at end of file