[
https://issues.apache.org/jira/browse/NIFI-2237?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15403865#comment-15403865
]
Matt Gilman commented on NIFI-2237:
-----------------------------------
1) There is a flag in the ApiModelProperty for readOnly. As well as
allowableValues, notes, required, example, etc. I don't think we need to use
all of these. Just the ones that describe the intent of each field.
However, there is a chance that we're not yet considering all of these fields
when generating the documentation. Updating this would be considered part of #3
above. Again, these annotations help generate a JSON document at build time.
That JSON document is placed in target/swagger-ui/swagger.json. Then this
document is run through a Handlebars template located at
src/main/resources/templates/index.html.hbs.
2) I would probably just make sure we're updating every DTO. Every object in
the nifi-client-dto is used for request/responses to/from the REST-API. Many
objects are used in all HTTP methods. For instance, ProcessorDTO is used in
POST, GET, PUT, and DELETE.
Thanks again! Let me know if you have any more questions.
> 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)
