Return-Path: X-Original-To: apmail-falcon-dev-archive@minotaur.apache.org Delivered-To: apmail-falcon-dev-archive@minotaur.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id 22BE517221 for ; Tue, 22 Sep 2015 07:22:09 +0000 (UTC) Received: (qmail 21559 invoked by uid 500); 22 Sep 2015 07:22:09 -0000 Delivered-To: apmail-falcon-dev-archive@falcon.apache.org Received: (qmail 21517 invoked by uid 500); 22 Sep 2015 07:22:09 -0000 Mailing-List: contact dev-help@falcon.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@falcon.apache.org Delivered-To: mailing list dev@falcon.apache.org Received: (qmail 21506 invoked by uid 99); 22 Sep 2015 07:22:08 -0000 Received: from Unknown (HELO spamd3-us-west.apache.org) (209.188.14.142) by apache.org (qpsmtpd/0.29) with ESMTP; Tue, 22 Sep 2015 07:22:08 +0000 Received: from localhost (localhost [127.0.0.1]) by spamd3-us-west.apache.org (ASF Mail Server at spamd3-us-west.apache.org) with ESMTP id 4B44718098A for ; Tue, 22 Sep 2015 07:22:08 +0000 (UTC) X-Virus-Scanned: Debian amavisd-new at spamd3-us-west.apache.org X-Spam-Flag: NO X-Spam-Score: 3.975 X-Spam-Level: *** X-Spam-Status: No, score=3.975 tagged_above=-999 required=6.31 tests=[HEADER_FROM_DIFFERENT_DOMAINS=0.001, HTML_MESSAGE=3, KAM_LAZY_DOMAIN_SECURITY=1, RCVD_IN_MSPIKE_H3=-0.01, RCVD_IN_MSPIKE_WL=-0.01, RP_MATCHES_RCVD=-0.006] autolearn=disabled Received: from mx1-us-west.apache.org ([10.40.0.8]) by localhost (spamd3-us-west.apache.org [10.40.0.10]) (amavisd-new, port 10024) with ESMTP id SIJVzV8DNPrY for ; Tue, 22 Sep 2015 07:22:07 +0000 (UTC) Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by mx1-us-west.apache.org (ASF Mail Server at mx1-us-west.apache.org) with SMTP id 3994420F60 for ; Tue, 22 Sep 2015 07:22:07 +0000 (UTC) Received: (qmail 21483 invoked by uid 99); 22 Sep 2015 07:22:06 -0000 Received: from reviews-vm.apache.org (HELO reviews.apache.org) (140.211.11.40) by apache.org (qpsmtpd/0.29) with ESMTP; Tue, 22 Sep 2015 07:22:06 +0000 Received: from reviews.apache.org (localhost [127.0.0.1]) by reviews.apache.org (Postfix) with ESMTP id D87DC2835F0; Tue, 22 Sep 2015 07:22:04 +0000 (UTC) Content-Type: multipart/alternative; boundary="===============5967058910153668766==" MIME-Version: 1.0 Subject: Re: Review Request 38548: FALCON-438: Auto generate documentation for REST API From: "Narayan Periwal" To: "Falcon" , "Narayan Periwal" Date: Tue, 22 Sep 2015 07:22:04 -0000 Message-ID: <20150922072204.24659.81241@reviews.apache.org> X-ReviewBoard-URL: https://reviews.apache.org/ Auto-Submitted: auto-generated Sender: "Narayan Periwal" X-ReviewGroup: Falcon X-Auto-Response-Suppress: DR, RN, OOF, AutoReply X-ReviewRequest-URL: https://reviews.apache.org/r/38548/ X-Sender: "Narayan Periwal" References: <20150921095723.24659.31212@reviews.apache.org> In-Reply-To: <20150921095723.24659.31212@reviews.apache.org> Reply-To: "Narayan Periwal" X-ReviewRequest-Repository: falcon-git --===============5967058910153668766== MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: 7bit ----------------------------------------------------------- This is an automatically generated e-mail. To reply, visit: https://reviews.apache.org/r/38548/ ----------------------------------------------------------- (Updated Sept. 22, 2015, 7:22 a.m.) Review request for Falcon. Repository: falcon-git Description ------- To auto-generate the documentation for the rest api's, there is an enunciate plugin available in Maven. We can run enunciate as part of our build process and it generates nice HTML based documentation of our web services. It uses the javadoc of the api's for the documentation purpose. Diffs (updated) ----- docs/src/site/twiki/restapi/ResourceList.twiki 8dc4a49 pom.xml 646de69 prism/enunciate.xml PRE-CREATION prism/pom.xml 6eca0b9 prism/src/main/java/org/apache/falcon/resource/admin/AdminResource.java 50b668c prism/src/main/java/org/apache/falcon/resource/metadata/LineageMetadataResource.java d595221 prism/src/main/java/org/apache/falcon/resource/metadata/MetadataDiscoveryResource.java 220cc42 prism/src/main/java/org/apache/falcon/resource/proxy/InstanceManagerProxy.java 3343c52 prism/src/main/java/org/apache/falcon/resource/proxy/SchedulableEntityManagerProxy.java 61a80c1 webapp/pom.xml 828f7f5 Diff: https://reviews.apache.org/r/38548/diff/ Testing ------- Done. Thanks, Narayan Periwal --===============5967058910153668766==--