[jira] [Commented] (NIFIREG-172) Add self-hosted Swagger UI to nifi-registry-web-api WAR

["ASF GitHub Bot (JIRA)" <ji...@apache.org>]

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

ASF GitHub Bot commented on NIFIREG-172:
----------------------------------------

GitHub user kevdoran opened a pull request:

    https://github.com/apache/nifi-registry/pull/119

    NIFIREG-172 Adds Swagger UI

    Contains the following changes:
    
    - Adds self-hosted Swagger UI to nifi-registry-web-api WAR at /swagger/ui.html
    - Updates NOTICE for included ALv2 licensed source
    - Adds Jersey filter exclusion for resources starting with /swagger/*
    - Adds top-level authorizable resource type for /swagger/*
    - Updates ResourceAuthorizationFilter configuration to include swagger resource type
    - Corrects name of Position model object in Swagger specification
    - Corrects duplicate operationId/nickname field for methods in FlowResource and BucketFlowResource
    
    For reviewers:
    
    - Verify /nifi-registry-api/swagger/ui.html is accessible and working in unsecured mode.
    - Verify /nifi-registry-api/swagger/swagger.json returns a good Swagger spec.
    - In secured mode, an initial admin should have access, as should any user who is granted read access to the "/swagger" resource
    - Verify changes to NOTICE in source code and nifi-registry-assembly
    
    


You can merge this pull request into a Git repository by running:

    $ git pull https://github.com/kevdoran/nifi-registry NIFIREG-172-swagger-ui

Alternatively you can review and apply these changes as the patch at:

    https://github.com/apache/nifi-registry/pull/119.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 #119
    
----
commit 8eef21c9481f795500a0a5d995deb2bdabf1899d
Author: Kevin Doran <kd...@...>
Date:   2018-05-29T16:13:06Z

    NIFIREG-172 Adds Swagger UI
    
    - Adds self-hosted Swagger UI to nifi-registry-web-api WAR at /swagger/ui.html
    - Updates NOTICE for included ALv2 licensed source.
    - Adds Jersey filter exclusion for resources starting with /swagger/*
    - Adds top-level authorizable resource type for /swagger/*
    - Updates ResourceAuthorizationFilter configuration to include swagger resource type
    - Corrects name of Position model object in Swagger specification
    - Corrects duplicate operationId/nickname field for methods in
      FlowResource and BucketFlowResource

----


> Add self-hosted Swagger UI to nifi-registry-web-api WAR
> -------------------------------------------------------
>
>                 Key: NIFIREG-172
>                 URL: https://issues.apache.org/jira/browse/NIFIREG-172
>             Project: NiFi Registry
>          Issue Type: Improvement
>            Reporter: Kevin Doran
>            Assignee: Kevin Doran
>            Priority: Minor
>             Fix For: 0.2.0
>
>
> Currently in NiFi Registry, a detailed Swagger specification for the NiFi Registry REST API is being generated as part of the build. This is used for a number of things, including input into the REST API documentation handlebars.js templates and an input into downstream, community projects such as NiPyAPi [1].
> The Swagger project also offers an Apache Licensed (ALv2) UI that consists of static html/js/css files that are capable of rendering any swagger.json specification in the form of a high-quality, interactive REST API documentation. The interactive nature of this UI makes it a very useful developer tool for testing backend changes to the REST API functionality without a standalone REST API test client. The Swagger UI project is hosted on GitHub [2]. There is also an online demo of the Swagger UI [3].
> This ticket is to augment the maven build for the nifi-registry-web-api war to bundle those static Swagger UI assets, enabling our swagger.json that is already being generated to be exposed through the Swagger UI as an additional resource.
> The swagger ui static assets should be hosted at /nifi-registry-api/swagger/* and a pseudo-resource type for "swagger" will have to be added to the authorization resource types in order to allow administrators to control user access, in a similar manner to the actuator endpoints.
> [1] https://github.com/Chaffelson/nipyapi
> [2] https://github.com/swagger-api/swagger-ui
> [3] http://petstore.swagger.io/



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)