[
https://issues.apache.org/jira/browse/NIFIREG-146?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16368362#comment-16368362
]
ASF GitHub Bot commented on NIFIREG-146:
----------------------------------------
GitHub user kevdoran opened a pull request:
https://github.com/apache/nifi-registry/pull/103
NIFIREG-146 REST API Documentation improvements
Improves the REST API documentation and swagger spec, including:
- Corrects handling of collection response types in REST API docs
- Adds required access policy information in REST API docs
- Adds missing required=true tags to swagger spec
- Adds missing readOnly-true tags to swagger spec
- Adds security definitions to swagger spec
- Corrects VersionedConnection.zIndex field name in swagger spec
Functionality changes:
- Adds authorization check to the getFlowDiff endpoint
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/kevdoran/nifi-registry NIFIREG-146
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/nifi-registry/pull/103.patch
To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:
This closes #103
----
commit 44b32e1abd121dd9e5e32220bfebb13adfba80be
Author: Kevin Doran <kdoran@...>
Date: 2018-02-17T20:56:07Z
NIFIREG-146 REST API Documentation improvements
Improves the REST API documentation and swagger spec, including:
- Corrects handling of collection response types in REST API docs
- Adds required access policy information in REST API docs
- Adds missing required=true tags to swagger spec
- Adds missing readOnly-true tags to swagger spec
- Adds security definitions to swagger spec
- Corrects VersionedConnection.zIndex field name in swagger spec
Functionality changes:
- Adds authorization check to the getFlowDiff endpoint
----
> REST API Documentation Improvements
> -----------------------------------
>
> Key: NIFIREG-146
> URL: https://issues.apache.org/jira/browse/NIFIREG-146
> Project: NiFi Registry
> Issue Type: Improvement
> Affects Versions: 0.1.0
> Reporter: Kevin Doran
> Assignee: Kevin Doran
> Priority: Major
> Labels: swagger
> Fix For: 0.2.0
>
>
> The self-hosted REST API documentation that is generated using templated HTML
> files and the swagger.json needs the following improvements:
> * Collection response types are not being populated into the template
> correctly
> * Endpoints that require authorization to an access policy should be marked
> as such
> Additionally, the following improvements can be made to the Swagger output by
> the build:
> * Mark fields required in a few places where that is missing
> * Mark fields readOnly in a few places where that is missing
> * Proper security definitions and Authorization mappings
> * Correct VersionedConnection.zIndex field name in ApiOperation annotation
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
