hadoop-hdfs-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Anu Engineer (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (HDFS-12690) Ozone: generate swagger descriptor for the Ozone REST Api
Date Thu, 26 Oct 2017 17:19:00 GMT

    [ https://issues.apache.org/jira/browse/HDFS-12690?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=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-unsubscribe@hadoop.apache.org
For additional commands, e-mail: hdfs-issues-help@hadoop.apache.org


Mime
View raw message