[jira] [Commented] (HDFS-12690) Ozone: generate swagger descriptor for the Ozone REST Api
[ https://issues.apache.org/jira/browse/HDFS-12690?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16455305#comment-16455305 ] Hudson commented on HDFS-12690: --- SUCCESS: Integrated in Jenkins build Hadoop-trunk-Commit #14070 (See [https://builds.apache.org/job/Hadoop-trunk-Commit/14070/]) HDFS-12690. Ozone: generate swagger descriptor for the Ozone REST Api. (omalley: rev 333dae888cdf235426a9df7a29f4d86cf419b9f8) * (edit) hadoop-hdfs-project/hadoop-hdfs/pom.xml * (edit) hadoop-hdfs-project/hadoop-hdfs/src/main/java/org/apache/hadoop/ozone/web/interfaces/Keys.java * (edit) hadoop-hdfs-project/hadoop-hdfs/src/main/java/org/apache/hadoop/ozone/web/interfaces/Bucket.java * (edit) hadoop-hdfs-project/hadoop-hdfs/src/main/java/org/apache/hadoop/ozone/web/interfaces/Volume.java > Ozone: generate swagger descriptor for the Ozone REST Api > - > > Key: HDFS-12690 > URL: https://issues.apache.org/jira/browse/HDFS-12690 > Project: Hadoop HDFS > Issue Type: Sub-task > Components: ozone >Affects Versions: HDFS-7240 >Reporter: Elek, Marton >Assignee: Elek, Marton >Priority: Major > Fix For: HDFS-7240 > > Attachments: HDFS-12690-HDFS-7240.001.patch > > > This patch generates ozone.swagger.json descriptor during compilation time > and adds it to the static/ web folder (available both from all web ui). > Note: I tested multiple method to generate swagger file: runtime and > compilation time. Runtime needs more additional dependencies and multiple > workaround as we have no ServletContext and ServletConfig in the netty based > adapter (but it's possible to add a stub one). I prefer the compilation time > generation because it more simplified and it also could be used to generate > additional documentation. > This patch contains only the basic @Api/@ApiMethod annotations the parameters > not yet annotated. Followup tasks: > * We can check how can we generate parameter level description from the > javadoc. It is possible with custom docket + custom swagger reader, but maybe > doesn't worth it. > * We can add a swagger ui (there are many implementations). It's a licence > nightmare as most of the ui contains unlimited number of npm dependency with > different (but mostly Apache + MIT) artifacts. I will suggest to add a > swagger ui without the javascript and load it from cdn. It will work only > with active internet connection but without licencing issue. > * Long term with this plugin we can also generate the content of > OzoneRest.md (after a fine tuning the swagger annotations) -- This message was sent by Atlassian JIRA (v7.6.3#76005) - To unsubscribe, e-mail: hdfs-issues-unsubscr...@hadoop.apache.org For additional commands, e-mail: hdfs-issues-h...@hadoop.apache.org
[jira] [Commented] (HDFS-12690) Ozone: generate swagger descriptor for the Ozone REST Api
[ https://issues.apache.org/jira/browse/HDFS-12690?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16451093#comment-16451093 ] Hudson commented on HDFS-12690: --- SUCCESS: Integrated in Jenkins build Hadoop-trunk-Commit #14057 (See [https://builds.apache.org/job/Hadoop-trunk-Commit/14057/]) HDFS-12690. Ozone: generate swagger descriptor for the Ozone REST Api. (aengineer: rev 8ba663176b6b8c040bec62bb80155a64cbffa1ae) * (edit) hadoop-hdfs-project/hadoop-hdfs/src/main/java/org/apache/hadoop/ozone/web/interfaces/Keys.java * (edit) hadoop-hdfs-project/hadoop-hdfs/src/main/java/org/apache/hadoop/ozone/web/interfaces/Volume.java * (edit) hadoop-hdfs-project/hadoop-hdfs/pom.xml * (edit) hadoop-hdfs-project/hadoop-hdfs/src/main/java/org/apache/hadoop/ozone/web/interfaces/Bucket.java > Ozone: generate swagger descriptor for the Ozone REST Api > - > > Key: HDFS-12690 > URL: https://issues.apache.org/jira/browse/HDFS-12690 > Project: Hadoop HDFS > Issue Type: Sub-task > Components: ozone >Affects Versions: HDFS-7240 >Reporter: Elek, Marton >Assignee: Elek, Marton >Priority: Major > Fix For: HDFS-7240 > > Attachments: HDFS-12690-HDFS-7240.001.patch > > > This patch generates ozone.swagger.json descriptor during compilation time > and adds it to the static/ web folder (available both from all web ui). > Note: I tested multiple method to generate swagger file: runtime and > compilation time. Runtime needs more additional dependencies and multiple > workaround as we have no ServletContext and ServletConfig in the netty based > adapter (but it's possible to add a stub one). I prefer the compilation time > generation because it more simplified and it also could be used to generate > additional documentation. > This patch contains only the basic @Api/@ApiMethod annotations the parameters > not yet annotated. Followup tasks: > * We can check how can we generate parameter level description from the > javadoc. It is possible with custom docket + custom swagger reader, but maybe > doesn't worth it. > * We can add a swagger ui (there are many implementations). It's a licence > nightmare as most of the ui contains unlimited number of npm dependency with > different (but mostly Apache + MIT) artifacts. I will suggest to add a > swagger ui without the javascript and load it from cdn. It will work only > with active internet connection but without licencing issue. > * Long term with this plugin we can also generate the content of > OzoneRest.md (after a fine tuning the swagger annotations) -- This message was sent by Atlassian JIRA (v7.6.3#76005) - To unsubscribe, e-mail: hdfs-issues-unsubscr...@hadoop.apache.org For additional commands, e-mail: hdfs-issues-h...@hadoop.apache.org
[jira] [Commented] (HDFS-12690) Ozone: generate swagger descriptor for the Ozone REST Api
[ https://issues.apache.org/jira/browse/HDFS-12690?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16220828#comment-16220828 ] Anu Engineer commented on HDFS-12690: - +1, I am will commit this shortly. > Ozone: generate swagger descriptor for the Ozone REST Api > - > > Key: HDFS-12690 > URL: https://issues.apache.org/jira/browse/HDFS-12690 > Project: Hadoop HDFS > Issue Type: Sub-task > Components: ozone >Affects Versions: HDFS-7240 >Reporter: Elek, Marton >Assignee: Elek, Marton > Attachments: HDFS-12690-HDFS-7240.001.patch > > > This patch generates ozone.swagger.json descriptor during compilation time > and adds it to the static/ web folder (available both from all web ui). > Note: I tested multiple method to generate swagger file: runtime and > compilation time. Runtime needs more additional dependencies and multiple > workaround as we have no ServletContext and ServletConfig in the netty based > adapter (but it's possible to add a stub one). I prefer the compilation time > generation because it more simplified and it also could be used to generate > additional documentation. > This patch contains only the basic @Api/@ApiMethod annotations the parameters > not yet annotated. Followup tasks: > * We can check how can we generate parameter level description from the > javadoc. It is possible with custom docket + custom swagger reader, but maybe > doesn't worth it. > * We can add a swagger ui (there are many implementations). It's a licence > nightmare as most of the ui contains unlimited number of npm dependency with > different (but mostly Apache + MIT) artifacts. I will suggest to add a > swagger ui without the javascript and load it from cdn. It will work only > with active internet connection but without licencing issue. > * Long term with this plugin we can also generate the content of > OzoneRest.md (after a fine tuning the swagger annotations) -- This message was sent by Atlassian JIRA (v6.4.14#64029) - To unsubscribe, e-mail: hdfs-issues-unsubscr...@hadoop.apache.org For additional commands, e-mail: hdfs-issues-h...@hadoop.apache.org
[jira] [Commented] (HDFS-12690) Ozone: generate swagger descriptor for the Ozone REST Api
[
https://issues.apache.org/jira/browse/HDFS-12690?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16216371#comment-16216371
]
Hadoop QA commented on HDFS-12690:
--
| (x) *{color:red}-1 overall{color}* |
\\
\\
|| Vote || Subsystem || Runtime || Comment ||
| {color:blue}0{color} | {color:blue} reexec {color} | {color:blue} 7m
0s{color} | {color:blue} Docker mode activated. {color} |
|| || || || {color:brown} Prechecks {color} ||
| {color:green}+1{color} | {color:green} @author {color} | {color:green} 0m
0s{color} | {color:green} The patch does not contain any @author tags. {color} |
| {color:red}-1{color} | {color:red} test4tests {color} | {color:red} 0m
0s{color} | {color:red} The patch doesn't appear to include any new or modified
tests. Please justify why no new tests are needed for this patch. Also please
list what manual steps were performed to verify this patch. {color} |
|| || || || {color:brown} HDFS-7240 Compile Tests {color} ||
| {color:green}+1{color} | {color:green} mvninstall {color} | {color:green} 15m
18s{color} | {color:green} HDFS-7240 passed {color} |
| {color:green}+1{color} | {color:green} compile {color} | {color:green} 0m
51s{color} | {color:green} HDFS-7240 passed {color} |
| {color:green}+1{color} | {color:green} checkstyle {color} | {color:green} 0m
35s{color} | {color:green} HDFS-7240 passed {color} |
| {color:green}+1{color} | {color:green} mvnsite {color} | {color:green} 0m
57s{color} | {color:green} HDFS-7240 passed {color} |
| {color:green}+1{color} | {color:green} shadedclient {color} | {color:green}
10m 29s{color} | {color:green} branch has no errors when building and testing
our client artifacts. {color} |
| {color:green}+1{color} | {color:green} findbugs {color} | {color:green} 1m
54s{color} | {color:green} HDFS-7240 passed {color} |
| {color:green}+1{color} | {color:green} javadoc {color} | {color:green} 0m
56s{color} | {color:green} HDFS-7240 passed {color} |
|| || || || {color:brown} Patch Compile Tests {color} ||
| {color:green}+1{color} | {color:green} mvninstall {color} | {color:green} 1m
0s{color} | {color:green} the patch passed {color} |
| {color:green}+1{color} | {color:green} compile {color} | {color:green} 0m
56s{color} | {color:green} the patch passed {color} |
| {color:green}+1{color} | {color:green} javac {color} | {color:green} 0m
56s{color} | {color:green} the patch passed {color} |
| {color:orange}-0{color} | {color:orange} checkstyle {color} | {color:orange}
0m 32s{color} | {color:orange} hadoop-hdfs-project/hadoop-hdfs: The patch
generated 2 new + 2 unchanged - 0 fixed = 4 total (was 2) {color} |
| {color:green}+1{color} | {color:green} mvnsite {color} | {color:green} 0m
59s{color} | {color:green} the patch passed {color} |
| {color:green}+1{color} | {color:green} whitespace {color} | {color:green} 0m
0s{color} | {color:green} The patch has no whitespace issues. {color} |
| {color:green}+1{color} | {color:green} xml {color} | {color:green} 0m
1s{color} | {color:green} The patch has no ill-formed XML file. {color} |
| {color:green}+1{color} | {color:green} shadedclient {color} | {color:green}
10m 13s{color} | {color:green} patch has no errors when building and testing
our client artifacts. {color} |
| {color:green}+1{color} | {color:green} findbugs {color} | {color:green} 2m
8s{color} | {color:green} the patch passed {color} |
| {color:green}+1{color} | {color:green} javadoc {color} | {color:green} 0m
54s{color} | {color:green} the patch passed {color} |
|| || || || {color:brown} Other Tests {color} ||
| {color:red}-1{color} | {color:red} unit {color} | {color:red} 90m 36s{color}
| {color:red} hadoop-hdfs in the patch failed. {color} |
| {color:green}+1{color} | {color:green} asflicense {color} | {color:green} 0m
20s{color} | {color:green} The patch does not generate ASF License warnings.
{color} |
| {color:black}{color} | {color:black} {color} | {color:black}145m 12s{color} |
{color:black} {color} |
\\
\\
|| Reason || Tests ||
| Failed junit tests | hadoop.hdfs.TestDFSStripedOutputStreamWithFailure |
| | hadoop.hdfs.web.TestWebHdfsTimeouts |
| | hadoop.hdfs.server.datanode.TestDataNodeVolumeFailureToleration |
| Timed out junit tests | org.apache.hadoop.hdfs.TestLeaseRecovery2 |
\\
\\
|| Subsystem || Report/Notes ||
| Docker | Image:yetus/hadoop:ca8ddc6 |
| JIRA Issue | HDFS-12690 |
| JIRA Patch URL |
https://issues.apache.org/jira/secure/attachment/12893224/HDFS-12690-HDFS-7240.001.patch
|
| Optional Tests | asflicense compile javac javadoc mvninstall mvnsite
unit shadedclient xml findbugs checkstyle |
| uname | Linux 071da376b2fc 4.4.0-43-generic #63-Ubuntu SMP Wed Oct 12
13:48:03 UTC 2016 x86_64 x86_64 x86_64 GNU/Linux |
| Build tool | maven |
| Personality | /testptch/hadoop/patchprocess/precommit/personality/provided.sh
|
| git revision | HDFS-7240 / 2628d1b |
| maven | version: Apache Maven 3.3.9 |
| Default
[jira] [Commented] (HDFS-12690) Ozone: generate swagger descriptor for the Ozone REST Api
[
https://issues.apache.org/jira/browse/HDFS-12690?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16212728#comment-16212728
]
Hadoop QA commented on HDFS-12690:
--
| (x) *{color:red}-1 overall{color}* |
\\
\\
|| Vote || Subsystem || Runtime || Comment ||
| {color:blue}0{color} | {color:blue} reexec {color} | {color:blue} 0m
0s{color} | {color:blue} Docker mode activated. {color} |
| {color:red}-1{color} | {color:red} docker {color} | {color:red} 0m
12s{color} | {color:red} Docker failed to build yetus/hadoop:71bbb86. {color} |
\\
\\
|| Subsystem || Report/Notes ||
| JIRA Issue | HDFS-12690 |
| JIRA Patch URL |
https://issues.apache.org/jira/secure/attachment/12893224/HDFS-12690-HDFS-7240.001.patch
|
| Console output |
https://builds.apache.org/job/PreCommit-HDFS-Build/21764/console |
| Powered by | Apache Yetus 0.6.0-SNAPSHOT http://yetus.apache.org |
This message was automatically generated.
> Ozone: generate swagger descriptor for the Ozone REST Api
> -
>
> Key: HDFS-12690
> URL: https://issues.apache.org/jira/browse/HDFS-12690
> Project: Hadoop HDFS
> Issue Type: Sub-task
> Components: ozone
>Affects Versions: HDFS-7240
>Reporter: Elek, Marton
>Assignee: Elek, Marton
> Attachments: HDFS-12690-HDFS-7240.001.patch
>
>
> This patch generates ozone.swagger.json descriptor during compilation time
> and adds it to the static/ web folder (available both from all web ui).
> Note: I tested multiple method to generate swagger file: runtime and
> compilation time. Runtime needs more additional dependencies and multiple
> workaround as we have no ServletContext and ServletConfig in the netty based
> adapter (but it's possible to add a stub one). I prefer the compilation time
> generation because it more simplified and it also could be used to generate
> additional documentation.
> This patch contains only the basic @Api/@ApiMethod annotations the parameters
> not yet annotated. Followup tasks:
> * We can check how can we generate parameter level description from the
> javadoc. It is possible with custom docket + custom swagger reader, but maybe
> doesn't worth it.
> * We can add a swagger ui (there are many implementations). It's a licence
> nightmare as most of the ui contains unlimited number of npm dependency with
> different (but mostly Apache + MIT) artifacts. I will suggest to add a
> swagger ui without the javascript and load it from cdn. It will work only
> with active internet connection but without licencing issue.
> * Long term with this plugin we can also generate the content of
> OzoneRest.md (after a fine tuning the swagger annotations)
--
This message was sent by Atlassian JIRA
(v6.4.14#64029)
-
To unsubscribe, e-mail: hdfs-issues-unsubscr...@hadoop.apache.org
For additional commands, e-mail: hdfs-issues-h...@hadoop.apache.org
