[jira] [Commented] (NIFI-2237) REST API Documentation Updates

["Matt Gilman (JIRA)" <ji...@apache.org>]

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

Matt Gilman commented on NIFI-2237:
-----------------------------------

Further break down of the work necessary for this JIRA.

1) Updating the annotations on the REST resources themselves.

- Description of endpoint
- Description of supported content types
- Description of possible response codes and what they mean
- Description of how that endpoint is authorized
- Add Yetus like description if endpoint is not guaranteed 

2) Updating the annotations on the DTOs that are used to send requests and return responses.

- Description of the request/response object
- Description of the objects in these objects (required vs optional, allowable values, read-only, etc)

3) Updating the documentation UI to ensure endpoints are grouped correctly

> 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)