nifi-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Matt Gilman (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (NIFI-292) Replace/Update REST API documentation generator
Date Tue, 21 Apr 2015 18:33:00 GMT

    [ https://issues.apache.org/jira/browse/NIFI-292?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14505448#comment-14505448
] 

Matt Gilman commented on NIFI-292:
----------------------------------

After working with the swagger 2.0 specification there appears to be a shortcoming that may
prevent us from using it. The is no support for overloading operations on a given path. This
is problematic if the endpoint in question can consume/produce multiple content types. 

> Replace/Update REST API documentation generator
> -----------------------------------------------
>
>                 Key: NIFI-292
>                 URL: https://issues.apache.org/jira/browse/NIFI-292
>             Project: Apache NiFi
>          Issue Type: Improvement
>          Components: Core Framework, Core UI
>            Reporter: Matt Gilman
>            Assignee: Matt Gilman
>
> Currently, we use enunciate to generate our REST API documentation. As part of the generated
docs, a JS library with a questionable license is included. 
> Consider updating the usage to use a custom Freemarker Transform as specified here:
> http://docs.codehaus.org/display/ENUNCIATE/Applying+a+Custom+Skin+to+Enunciate%27s+Documentation
> or switching to another solution altogether.



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)

Mime
View raw message