Update SDK documentation 49/100849/1
authorpwielebs <piotr.wielebski@nokia.com>
Tue, 28 Jan 2020 12:15:48 +0000 (13:15 +0100)
committerpwielebs <piotr.wielebski@nokia.com>
Tue, 28 Jan 2020 12:15:48 +0000 (13:15 +0100)
Signed-off-by: pwielebs <piotr.wielebski@nokia.com>
Issue-ID: DCAEGEN2-2044
Change-Id: I3a2c2aaf712a059eb04bfb6ee3866f797a4eaf9e

docs/sections/apis/SDK.rst

index b118ad9..e1ffc60 100644 (file)
@@ -13,45 +13,90 @@ 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.
+configuration from CBS, consuming messages from DMaaP, etc. SDK is written in Java.
 
 Introduction
 ------------
 
-    SDK Maven dependencies (modules).
+      SDK Maven dependencies (modules).
 
-    .. code-block:: XML
+      .. code-block:: XML
 
             <properties>
-                <sdk.version>1.1.6</sdk.version>
+                <sdk.version>1.3.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.rest.services</groupId>
+                  <artifactId>dmaap-client</artifactId>
+                  <version>${sdk.version}</version>
+                </dependency>
+
+                <dependency>
+                  <groupId>org.onap.dcaegen2.services.sdk.rest.services</groupId>
+                  <artifactId>http-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.security</groupId>
+                  <artifactId>ssl</artifactId>
+                  <version>${sdk.version}</version>
+                </dependency>
+
                 <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 -->
+                  <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>
+
+
+Revision history
+----------------
+
+   **1.3.4**
+      - Usage of Java 11
+
+   **1.3.3-SNAPSHOT**
+      - Upgrade CBS to support SSL
+      - Fix static code vulnerabilities
+      - Exclude IT from tests
+      - Remove AAI client from SDK
+
+   **1.3.2-SNAPSHOT**
+      - Restructure AAI client
+      - Get rid of common-dependency module
+      - Rearrange files in packages inside rest-services
+
+   **1.3.1-SNAPSHOT**
+      - Bugfix release: AAI client
+         - Make AaiGetServiceInstanceClient build correct path to the service resource in AAI
+
+   **1.3.0-SNAPSHOT** (ElAlto - under development)
+      - All El-Alto work noted under 1.2.0-SNAPSHOT will roll into this version
+      - Version update was done for tracking global-jjb migration work and corresponding submission - https://gerrit.onap.org/r/#/c/dcaegen2/services/sdk/+/89902/
\ No newline at end of file