clean up some sphinx warnings
[dcaegen2.git] / docs / sections / apis / SDK.rst
1 .. This work is licensed under a
2    Creative Commons Attribution 4.0 International License.
3    http://creativecommons.org/licenses/by/4.0
4
5
6 DCAE SDK
7 ========
8
9 .. contents::
10     :depth: 3
11 ..
12
13 Overview
14 --------
15
16 DCAE SDK contains utilities and clients which may be used for fetching
17 configuration from CBS, consuming messages from DMaaP, etc. SDK is written in Java.
18
19 Artifacts
20 ---------
21
22 Current version
23 ~~~~~~~~~~~~~~~
24 .. code-block:: xml
25
26     <properties>
27         <sdk.version>1.4.2</sdk.version>
28     </properties>
29
30
31 SDK Maven dependencies (modules)
32 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
33
34 .. code-block:: xml
35
36             <dependencies>
37                 <dependency>
38                   <groupId>org.onap.dcaegen2.services.sdk.rest.services</groupId>
39                   <artifactId>cbs-client</artifactId>
40                   <version>${sdk.version}</version>
41                 </dependency>
42
43                 <dependency>
44                   <groupId>org.onap.dcaegen2.services.sdk.rest.services</groupId>
45                   <artifactId>dmaap-client</artifactId>
46                   <version>${sdk.version}</version>
47                 </dependency>
48
49                 <dependency>
50                   <groupId>org.onap.dcaegen2.services.sdk.rest.services</groupId>
51                   <artifactId>http-client</artifactId>
52                   <version>${sdk.version}</version>
53                 </dependency>
54
55                 <dependency>
56                   <groupId>org.onap.dcaegen2.services.sdk.security.crypt</groupId>
57                   <artifactId>crypt-password</artifactId>
58                   <version>${sdk.version}</version>
59                 </dependency>
60
61                 <dependency>
62                   <groupId>org.onap.dcaegen2.services.sdk.security</groupId>
63                   <artifactId>ssl</artifactId>
64                   <version>${sdk.version}</version>
65                 </dependency>
66
67                 <dependency>
68                   <groupId>org.onap.dcaegen2.services.sdk</groupId>
69                   <artifactId>hvvesclient-producer-api</artifactId>
70                   <version>${sdk.version}</version>
71                 </dependency>
72
73                 <dependency>
74                   <groupId>org.onap.dcaegen2.services.sdk</groupId>
75                   <artifactId>hvvesclient-producer-impl</artifactId>
76                   <version>${sdk.version}</version>
77                   <scope>runtime</scope>
78                 </dependency>
79
80                 <dependency>
81                   <groupId>org.onap.dcaegen2.services.sdk</groupId>
82                   <artifactId>dcaegen2-services-sdk-services-external-schema-manager</artifactId>
83                   <version>${sdk.version}</version>
84                 </dependency>
85
86                 <!-- more to go -->
87             </dependencies>