[
https://issues.apache.org/jira/browse/NIFI-2237?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15401301#comment-15401301
]
Joe Skora edited comment on NIFI-2237 at 7/31/16 7:32 PM:
----------------------------------------------------------
[~mcgilman], regarding #2 it seems to me that documenting read-only values only
applies when a DTO is used for a PUT or POST request. For instance,
documenting "This property is read-only" on every property in the
AccessStatusDTO seems redudant since that is only ever used as a response
object.
Also, required vs. optional and allowable values seem to track from the
ApiModelProperty annotation on the DTO to the API docs, but the read-only
status does not.
1. Is adding "This property is read-only" the key thing here for the read-only
fields?
2 Should this be updated even if the DTO is only used for read-only response
objects?
(edited to clarify)
was (Author: jskora):
[~mcgilman], regarding #2 it seems to me that documenting read-only, required
vs optional, and allowable values only applies when a DTO is used for a PUT or
POST request. For instance, documenting "This property is read-only" on every
property in the AccessStatusDTO seems redudant since that is only ever used as
a response object.
Does that make sense or should they be documented anywhere the ApiModelProperty
annotation tags something as read-only?
> 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)
