From: Sripad Date: Tue, 13 Feb 2018 16:53:35 +0000 (+0000) Subject: Update documentation file & sonar plugin X-Git-Tag: 2.0.0-ONAP~2 X-Git-Url: https://gerrit.onap.org/r/gitweb?p=dmaap%2Fdatarouter.git;a=commitdiff_plain;h=bcf88dca55b8201dd5a47b54f08afe8d4166f569 Update documentation file & sonar plugin Issue-ID: DMAAP-109 Change-Id: Ifb68600de75622791eba4fb3e9b472b39850afec Signed-off-by: Sai Gandham --- diff --git a/datarouter-node/pom.xml b/datarouter-node/pom.xml index d8c2be31..1db177f2 100644 --- a/datarouter-node/pom.xml +++ b/datarouter-node/pom.xml @@ -43,6 +43,14 @@ 1.8 1.8 ${basedir}/target/ + java + false + jacoco + ${project.build.directory}/surefire-reports + ${project.build.directory}/coverage-reports/jacoco.exec + ${project.build.directory}/coverage-reports/jacoco-it.exec + true + ${project.version} https://nexus.onap.org /content/repositories/snapshots/ /content/repositories/releases/ @@ -405,18 +413,93 @@ + + org.sonatype.plugins + nexus-staging-maven-plugin + 1.6.7 + true + + ${nexusproxy} + 176c31dfe190a + ecomp-staging + + + + + org.jacoco + jacoco-maven-plugin + ${jacoco.version} + + + **/gen/** + **/generated-sources/** + **/yang-gen/** + **/pax/** + + + + + + pre-unit-test + + prepare-agent + + + ${project.build.directory}/code-coverage/jacoco-ut.exec + surefireArgLine + + + + + + post-unit-test + test + + report + + + ${project.build.directory}/code-coverage/jacoco-ut.exec + ${project.reporting.outputDirectory}/jacoco-ut + + + + pre-integration-test + pre-integration-test + + prepare-agent + + + ${project.build.directory}/code-coverage/jacoco-it.exec + + failsafeArgLine + + + + + post-integration-test + post-integration-test + + report + + + ${project.build.directory}/code-coverage/jacoco-it.exec + ${project.reporting.outputDirectory}/jacoco-it + + + + ecomp-releases - AAF Release Repository + DR Release Repository ${nexusproxy}${releaseNexusPath} ecomp-snapshots - AAF Snapshot Repository + DR Snapshot Repository ${nexusproxy}${snapshotNexusPath} @@ -430,27 +513,6 @@ https://nexus.onap.org/content/repositories/snapshots/ - - - central - Maven 2 repository 2 - http://repo2.maven.org/maven2/ - - - onap-jar-snapshots - https://nexus.onap.org/content/repositories/snapshots - - - spring-repo - Spring repo - https://artifacts.alfresco.com/nexus/content/repositories/public/ - - - repository.jboss.org-public - JBoss.org Maven repository - https://repository.jboss.org/nexus/content/groups/public - - diff --git a/datarouter-prov/pom.xml b/datarouter-prov/pom.xml index 2f574f1c..a9e7e678 100644 --- a/datarouter-prov/pom.xml +++ b/datarouter-prov/pom.xml @@ -40,6 +40,14 @@ 1.8 1.8 ${basedir}/target/ + java + false + jacoco + ${project.build.directory}/surefire-reports + ${project.build.directory}/coverage-reports/jacoco.exec + ${project.build.directory}/coverage-reports/jacoco-it.exec + true + ${project.version} https://nexus.onap.org /content/repositories/snapshots/ /content/repositories/releases/ @@ -490,17 +498,95 @@ + + + + org.sonatype.plugins + nexus-staging-maven-plugin + 1.6.7 + true + + ${nexusproxy} + 176c31dfe190a + ecomp-staging + + + + + org.jacoco + jacoco-maven-plugin + ${jacoco.version} + + + **/gen/** + **/generated-sources/** + **/yang-gen/** + **/pax/** + + + + + + pre-unit-test + + prepare-agent + + + ${project.build.directory}/code-coverage/jacoco-ut.exec + surefireArgLine + + + + + + post-unit-test + test + + report + + + ${project.build.directory}/code-coverage/jacoco-ut.exec + ${project.reporting.outputDirectory}/jacoco-ut + + + + pre-integration-test + pre-integration-test + + prepare-agent + + + ${project.build.directory}/code-coverage/jacoco-it.exec + + failsafeArgLine + + + + + + post-integration-test + post-integration-test + + report + + + ${project.build.directory}/code-coverage/jacoco-it.exec + ${project.reporting.outputDirectory}/jacoco-it + + + + ecomp-releases - AAF Release Repository + DR Release Repository ${nexusproxy}${releaseNexusPath} ecomp-snapshots - AAF Snapshot Repository + DR Snapshot Repository ${nexusproxy}${snapshotNexusPath} @@ -515,26 +601,5 @@ - - - central - Maven 2 repository 2 - http://repo2.maven.org/maven2/ - - - onap-jar-snapshots - https://nexus.onap.org/content/repositories/snapshots - - - spring-repo - Spring repo - https://artifacts.alfresco.com/nexus/content/repositories/public/ - - - repository.jboss.org-public - JBoss.org Maven repository - https://repository.jboss.org/nexus/content/groups/public - - diff --git a/docs/index.rst b/docs/index.rst index 77b53fb4..f7dae490 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -2,13 +2,26 @@ .. http://creativecommons.org/licenses/by/4.0 .. Copyright © 2017 AT&T Intellectual Property. All rights reserved. -Message Router (MR) -==================== +============================================ +Data Router (DR) API Guide +============================================ +Introduction +------------------ + +The DataRouter(DR)provisioning API is an HTTPS-based,REST-like API for creating and managing DR feeds and subscriptions. The Data Routing System project is intended to provide a common framework by which data producers can make data available to data consumers and a way for potential consumers to find feeds with the data they require. + + +HTTP Service APIs +------------------ + +DMaaP Message Router utilizes an HTTP REST API to service all transactions. HTTP and REST standards are followed so +clients as varied as CURL, Java applications and even Web Browsers will +work to interact with the Data Router. .. toctree:: - :maxdepth: 2 + :maxdepth: 3 data-router/data-router diff --git a/pom.xml b/pom.xml index d655282a..edb9754f 100644 --- a/pom.xml +++ b/pom.xml @@ -41,6 +41,14 @@ UTF-8 1.8 1.8 + java + false + jacoco + ${project.build.directory}/surefire-reports + ${project.build.directory}/coverage-reports/jacoco.exec + ${project.build.directory}/coverage-reports/jacoco-it.exec + true + ${project.version} https://nexus.onap.org /content/repositories/snapshots/ /content/repositories/releases/ @@ -67,17 +75,94 @@ ecomp-staging + + + org.sonatype.plugins + nexus-staging-maven-plugin + 1.6.7 + true + + ${nexusproxy} + 176c31dfe190a + ecomp-staging + + + + + org.jacoco + jacoco-maven-plugin + ${jacoco.version} + + + **/gen/** + **/generated-sources/** + **/yang-gen/** + **/pax/** + + + + + + pre-unit-test + + prepare-agent + + + ${project.build.directory}/code-coverage/jacoco-ut.exec + surefireArgLine + + + + + + post-unit-test + test + + report + + + ${project.build.directory}/code-coverage/jacoco-ut.exec + ${project.reporting.outputDirectory}/jacoco-ut + + + + pre-integration-test + pre-integration-test + + prepare-agent + + + ${project.build.directory}/code-coverage/jacoco-it.exec + + failsafeArgLine + + + + + + post-integration-test + post-integration-test + + report + + + ${project.build.directory}/code-coverage/jacoco-it.exec + ${project.reporting.outputDirectory}/jacoco-it + + + + ecomp-releases - AAF Release Repository + DR Release Repository ${nexusproxy}${releaseNexusPath} ecomp-snapshots - AAF Snapshot Repository + DR Snapshot Repository ${nexusproxy}${snapshotNexusPath} @@ -91,26 +176,5 @@ https://nexus.onap.org/content/repositories/snapshots/ - - - - central - Maven 2 repository 2 - http://repo2.maven.org/maven2/ - - - onap-jar-snapshots - https://nexus.onap.org/content/repositories/snapshots - - - spring-repo - Spring repo - https://artifacts.alfresco.com/nexus/content/repositories/public/ - - - repository.jboss.org-public - JBoss.org Maven repository - https://repository.jboss.org/nexus/content/groups/public - - +