Repository: ranger Updated Branches: refs/heads/master 11bcd728e -> 84d132fcf
RANGER-1651 : Improve Ranger and Ranger KMS REST Api documentation Project: http://git-wip-us.apache.org/repos/asf/ranger/repo Commit: http://git-wip-us.apache.org/repos/asf/ranger/commit/84d132fc Tree: http://git-wip-us.apache.org/repos/asf/ranger/tree/84d132fc Diff: http://git-wip-us.apache.org/repos/asf/ranger/diff/84d132fc Branch: refs/heads/master Commit: 84d132fcf8df176e827144b83425fce5f89de312 Parents: 11bcd72 Author: Mehul Parikh <me...@apache.org> Authored: Mon Jun 19 12:04:09 2017 +0530 Committer: Mehul Parikh <me...@apache.org> Committed: Tue Jun 27 11:57:40 2017 +0530 ---------------------------------------------------------------------- docs/src/site/site.xml | 2 ++ enunciate.xml | 37 +++++++++++++++++++++++++++++++++++++ kms/pom.xml | 15 +++++++++++++++ pom.xml | 31 +++++++++++++++++++++++++++++-- security-admin/pom.xml | 17 ++++++++++++++++- 5 files changed, 99 insertions(+), 3 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/ranger/blob/84d132fc/docs/src/site/site.xml ---------------------------------------------------------------------- diff --git a/docs/src/site/site.xml b/docs/src/site/site.xml index 77dda96..9472dc2 100644 --- a/docs/src/site/site.xml +++ b/docs/src/site/site.xml @@ -46,6 +46,8 @@ under the License. <menu name="Resources"> <item name="Wiki" href="https://cwiki.apache.org/confluence/display/RANGER/Index"; /> <item name="Quick Start Guide" href="quick_start_guide.html"/> + <item name="Ranger REST API Documentation" href="apidocs/index.html"/> + <item name="Ranger KMS REST API Documentation" href="kms/apidocs/index.html"/> <!-- According to http://jira.codehaus.org/browse/MNGSITE-152 --> <item name="License" href="https://www.apache.org/licenses/"/> </menu> http://git-wip-us.apache.org/repos/asf/ranger/blob/84d132fc/enunciate.xml ---------------------------------------------------------------------- diff --git a/enunciate.xml b/enunciate.xml new file mode 100644 index 0000000..e185a41 --- /dev/null +++ b/enunciate.xml @@ -0,0 +1,37 @@ +<!-- + ~ Licensed to the Apache Software Foundation (ASF) under one + ~ or more contributor license agreements. See the NOTICE file + ~ distributed with this work for additional information + ~ regarding copyright ownership. The ASF licenses this file + ~ to you under the Apache License, Version 2.0 (the + ~ "License"); you may not use this file except in compliance + ~ with the License. You may obtain a copy of the License at + ~ + ~ http://www.apache.org/licenses/LICENSE-2.0 + ~ + ~ Unless required by applicable law or agreed to in writing, software + ~ distributed under the License is distributed on an "AS IS" BASIS, + ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + ~ See the License for the specific language governing permissions and + ~ limitations under the License. + --> +<enunciate xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; + xsi:noNamespaceSchemaLocation="http://enunciate.webcohesion.com/schemas/enunciate-2.8.0.xsd"; > + <title>Ranger REST API</title> + <description> Apache Ranger is a framework to enable, monitor and manage comprehensive data security across the Hadoop platform. Apache Ranger currently provides a centralized security adminstration, fine grain access control and detailed auditing for user access within Apache Hadoop, Apache Hive, Apache HBase and other Apache components</description> + <modules> + <swagger/> + <jackson/> + <jackson1 disabled="true"/> + <c-xml-client disabled="true"/> + <java-json-client disabled="true"/> + <csharp-xml-client disabled="true"/> + <java-xml-client disabled="true"/> + <javascript-client disabled="true"/> + <ruby-json-client disabled="true"/> + <gwt-json-overlay disabled="true"/> + <php-xml-client disabled="true"/> + <php-json-client disabled="true"/> + <jaxws disabled="true"/> + </modules> +</enunciate> http://git-wip-us.apache.org/repos/asf/ranger/blob/84d132fc/kms/pom.xml ---------------------------------------------------------------------- diff --git a/kms/pom.xml b/kms/pom.xml index 8e847bc..bc0d96f 100644 --- a/kms/pom.xml +++ b/kms/pom.xml @@ -262,6 +262,10 @@ <artifactId>api-i18n</artifactId> <version>1.0.0-M20</version> </dependency> + <dependency> + <groupId>com.webcohesion.enunciate</groupId> + <artifactId>enunciate-core-annotations</artifactId> + </dependency> </dependencies> <build> <pluginManagement> @@ -271,6 +275,17 @@ <artifactId>maven-war-plugin</artifactId> <version>2.6</version> </plugin> + <plugin> + <groupId>com.webcohesion.enunciate</groupId> + <artifactId>enunciate-maven-plugin</artifactId> + <configuration> + <configFile>enunciate.xml</configFile> + <enunciateArtifactId/> + <docsDir>docs/target/kms/</docsDir> + <source>1.8</source> + <target>1.8</target> + </configuration> + </plugin> </plugins> </pluginManagement> <resources> http://git-wip-us.apache.org/repos/asf/ranger/blob/84d132fc/pom.xml ---------------------------------------------------------------------- diff --git a/pom.xml b/pom.xml index a8403a9..a4764ea 100644 --- a/pom.xml +++ b/pom.xml @@ -340,7 +340,12 @@ <artifactId>gson</artifactId> <version>${gson.version}</version> </dependency> - </dependencies> + <dependency> + <groupId>com.webcohesion.enunciate</groupId> + <artifactId>enunciate-core-annotations</artifactId> + <version>2.8.0</version> + </dependency> + </dependencies> </dependencyManagement> <build> <pluginManagement> @@ -462,7 +467,27 @@ <artifactId>maven-release-plugin</artifactId> <version>2.5.2</version> </plugin> - </plugins> + <plugin> + <groupId>com.webcohesion.enunciate</groupId> + <artifactId>enunciate-maven-plugin</artifactId> + <version>2.8.0</version> + <configuration> + <configFile>enunciate.xml</configFile> + <enunciateArtifactId/> + <docsDir>docs/src/site/</docsDir> + <source>1.8</source> + <target>1.8</target> + </configuration> + <executions> + <execution> + <goals> + <goal>docs</goal> + </goals> + <phase>package</phase> + </execution> + </executions> + </plugin> + </plugins> </pluginManagement> <plugins> <plugin> @@ -563,6 +588,8 @@ <exclude>**/.pydevproject</exclude> <exclude>**/derby.log</exclude> <exclude>**/*.jaas</exclude> + <exclude>**/target/apidocs/**</exclude> + <exclude>**/target/kms/apidocs/**</exclude> </excludes> </configuration> </plugin> http://git-wip-us.apache.org/repos/asf/ranger/blob/84d132fc/security-admin/pom.xml ---------------------------------------------------------------------- diff --git a/security-admin/pom.xml b/security-admin/pom.xml index 2f99e3e..486cd58 100644 --- a/security-admin/pom.xml +++ b/security-admin/pom.xml @@ -475,7 +475,11 @@ <artifactId>guice</artifactId> <version>3.0</version> </dependency> - </dependencies> + <dependency> + <groupId>com.webcohesion.enunciate</groupId> + <artifactId>enunciate-core-annotations</artifactId> + </dependency> + </dependencies> <build> <pluginManagement> <plugins> @@ -557,6 +561,17 @@ </execution> </executions> </plugin> + <plugin> + <groupId>com.webcohesion.enunciate</groupId> + <artifactId>enunciate-maven-plugin</artifactId> + <configuration> + <configFile>enunciate.xml</configFile> + <enunciateArtifactId/> + <docsDir>docs/target/</docsDir> + <source>1.8</source> + <target>1.8</target> + </configuration> + </plugin> </plugins> <resources> <resource>
