You are viewing a plain text version of this content. The canonical link for it is here.

Posted to issues@nifi.apache.org by GitBox <gi...@apache.org> on 2019/04/01 14:30:26 UTC

[GitHub] [nifi-registry] bbende opened a new pull request #164: NIFIREG-245 Refactor REST API docs

bbende opened a new pull request #164: NIFIREG-245 Refactor REST API docs
URL: https://github.com/apache/nifi-registry/pull/164
 
 
   This PR changes the way the REST API documentation is generated to leverage the swagger2markup Maven plugin which produces asciidoc from the swagger.json, and then we can convert the asciidoc to html the same way we do for our other docs.
   
   In addition, this PR standardizes the use of all the @ ApiOperation annotations so that the main value is a short description closely resembling the Java method name, and the notes fields contains any further explanation.
   
   NOTE: This PR is based off the PR for NIFIREG-233 since there were additional REST methods in that PR that would be impacted by this PR.

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services