[
https://issues.apache.org/jira/browse/NIFI-2237?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15401167#comment-15401167
]
Matt Gilman commented on NIFI-2237:
-----------------------------------
Some additional background regarding #3...
We use Swagger to build our Rest Api documentation. This is done using Swagger
annotations on our Rest Endpoints and DTO model. During the build, those
annotations are used to be a JSON document according to the Swagger
specification. We then run that JSON document through a Handlebars Template to
generate our HTML docs. These templates can be found in
nifi-web-api/src/main/resources/templates.
Let me know about #3. I have no problem tackling it as well. Thanks for jumping
in and offering to help!
> REST API Documentation Updates
> ------------------------------
>
> Key: NIFI-2237
> URL: https://issues.apache.org/jira/browse/NIFI-2237
> Project: Apache NiFi
> Issue Type: Improvement
> Components: Core Framework
> Reporter: Matt Gilman
> Assignee: Matt Gilman
> Priority: Critical
> Fix For: 1.0.0
>
>
> - Ensure REST APi documentation is up to date.
> - Remove mention of deprecated user roles
> - Mark applicable endpoints with Yetus like descriptions according to
> intent/stability/openness.
> - Ensure all fields are correctly marked as optional or not.
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
